使用紅寶石中的注釋
您的Ruby代碼中的注釋是其他程序員要閱讀的注釋和注釋。Ruby解釋器忽略了注釋本身,因此注釋內(nèi)部的文本不受任何限制。
它'通常是在類和方法之前添加注釋以及任何可能復(fù)雜或不清楚的代碼的良好形式。
有效使用注釋
應(yīng)該使用注釋來提供背景信息或注釋困難的代碼。請注意,簡單地說下一行直截了當(dāng)?shù)拇a不僅顯而易見,而且還會給文件增加雜亂。
重要的是要注意不要使用太多評論,并確保文件中的評論對其他程序員有意義和幫助。
Shebang
你'請注意,所有紅寶石程序都以##開頭的注釋開始!。這被稱為shebang,用于Linux,Unix和OS X系統(tǒng)。
當(dāng)您執(zhí)行Ruby腳本時,shell(例如Linux或OS X上的bash)將在文件的第一行查找shebang。然后,shell將使用shebang查找Ruby解釋器并運(yùn)行腳本。
**的紅寶石shebang是##!/usr/bin/env ruby,但您也可以看到?!/usr/bin/ruby或#!/usr/local/bin/ruby。
單行注釋
Ruby單行注釋以#字符開頭,結(jié)尾于行的末尾。Ruby解釋器完全忽略#字符到行末尾的任何字符。
##字符不'不一定必須出現(xiàn)在線條的開頭;它可以出現(xiàn)在任何地方。
以下示例說明了注釋的一些用途。
#!/usr/bin/env ruby
#這條線被Ruby解釋器忽略
#此方法打印其參數(shù)之和
def sum(a,b)
放置a+b
end
sum(10,20)#打印總和10和20
病毒健康知識
多行注釋
雖然Ruby經(jīng)常被許多Ruby程序員遺忘,但Ruby確實(shí)有多行評論。多行注釋以=開始令牌開始,以=結(jié)束令牌結(jié)束。
這些令牌應(yīng)該從行首開始,并且是線上**的東西。Ruby解釋器會忽略這兩個令牌之間的任何內(nèi)容。
##!/usr/bin/env ruby
=begin
Between=begin and=end,任意數(shù)字
行可以寫。所有這些
行都被Ruby解釋器忽略。
=end
puts"你好世界!"
在這個例子中,代碼將執(zhí)行為Hello world!