注釋是在運行時會被忽略的 Ruby 代碼內(nèi)的注釋行。單行注釋以 # 字符開始,直到該行結(jié)束,如下所示:
#!/usr/bin/ruby -w
# 這是一個單行注釋。
puts "Hello, Ruby!"
當執(zhí)行時,上面的程序會產(chǎn)生以下結(jié)果:
Hello, Ruby!
您可以使用 =begin 和 =end 語法注釋多行,如下所示:
#!/usr/bin/ruby -w
puts "Hello, Ruby!"
=begin
這是一個多行注釋。
可擴展至任意數(shù)量的行。
但 =begin 和 =end 只能出現(xiàn)在第一行和最后一行。
=end
當執(zhí)行時,上面的程序會產(chǎn)生以下結(jié)果:
Hello, Ruby!
請確保尾部的注釋離代碼有足夠的距離,以便容易區(qū)分注釋和代碼。如果塊中超過一條尾部注釋,請對齊它們。例如:
@counter # 跟蹤頁面被擊中的次數(shù)
@siteCounter # 跟蹤所有頁面被擊中的次數(shù)