注释是在运行时会被忽略的 Ruby 代码内的注释行。单行注释以 # 字符开始,直到该行结束,如下所示:
#!/usr/bin/ruby -w
# 这是一个单行注释。
puts "Hello, Ruby!"
当执行时,上面的程序会产生以下结果:
Hello, Ruby!
您可以使用 =begin 和 =end 语法注释多行,如下所示:
#!/usr/bin/ruby -w
puts "Hello, Ruby!"
=begin
这是一个多行注释。
可扩展至任意数量的行。
但 =begin 和 =end 只能出现在第一行和最后一行。
=end
当执行时,上面的程序会产生以下结果:
Hello, Ruby!
请确保尾部的注释离代码有足够的距离,以便容易区分注释和代码。如果块中超过一条尾部注释,请对齐它们。例如:
@counter # 跟踪页面被击中的次数
@siteCounter # 跟踪所有页面被击中的次数