Ruby注釋的寫法 Markup

自然地書寫注釋。

源英文鏈結

比如, 產生上述文字的命令是:

1. 列表的標記為：

* '*' or '-' 表示著重號列表
* 數字加圓點用於數字列表

[cat]

small
domestic
animal
[+cat+]
command
tocopy
standard
input

cat::   small domestic animal

+cat+
:: command
to copy standard input

斜體     _word_  \text

加粗      *word* or \text列印字型   +word+ or \text

def

fred
...yield line, address

fred()

def

fred      # :yields: index, position
...yield line, address

fred()

':yields:'是文件修飾符的例子. 修飾符出現在#之後。其他的修飾符還包括

:nodoc:[all]將不會包含後面的文件。比如對於下列**

module

sm#:nodoc:
class
input
endendmodule
markup
#:nodoc: all
class
output
endend

:doc:強制新增文件. 如果想在文件中包含私有方法，這是有用的.

:notnew:

僅僅適用於構建方法。正常情況下，rdoc方法假設initialize的引數作為new方法的引數。因而會新增乙個new方法，通過該修飾符阻止這種做法。 注意initialize方法不會被顯示在文件中，除非你使用-a命令列選項。

rdoc通過#--阻止之後的注釋新增到文件中去，通過#++恢復

注釋也可以包含檔案。

:include:filename

將會包含明明檔案的內容. 該檔案會--include選項的路徑進行搜尋,或者預設是當前路徑.

:title:text

設定文件標題. e等價於--title命令列引數. (命令列引數優先順序最高).

:main:name等價於--main命令列引數。

ruby隨筆 注釋

ruby的注釋有單行和多行兩種。單行注釋 一行以 開頭，則該行是單行注釋，可以是一些函式說明 類說明等等，例如 i am single line comment exx.xx.rb this function define 多行注釋 以 begin作為第一行全部內容 寫在行首 以 end作為最後一行...

python中注釋的寫法

說明 記錄在python中注釋的寫法。1.單行注釋，行以 開頭 這是乙個單行注釋 print hello world 2.多行注釋，使用三個單引號，或者三個雙引號將其要注釋的內容擴起來 這是乙個單行注釋 第一行要注釋的內容 第二行要注釋的內容 第三行要注釋的內容 print hello world ...

Shell多行注釋寫法

假設我們想注釋多行 在bash中，我們可以這麼寫 這裡寫注釋內容 比如，沒注釋前，我的腳步是這樣的 bin bash export path gogoal platform ggopenapi play 1.2.7 path echo 構建後的路徑pwd pwd whoami cd home dev...