Ruby-comments
提供:Dev Guides
Ruby-コメント
コメントは、実行時に無視されるRubyコード内の注釈行です。 単一行のコメントは、#文字で始まり、次のように#から行末まで続きます-
#!/usr/bin/ruby -w
# This is a single line comment.
puts "Hello, Ruby!"
実行すると、上記のプログラムは次の結果を生成します-
Hello, Ruby!
Rubyマルチラインコメント
次のように = begin および = end 構文を使用して複数の行をコメントできます-
#!/usr/bin/ruby -w
puts "Hello, Ruby!"
=begin
This is a multiline comment and con spwan as many lines as you
like. But =begin and =end should come in the first line only.
=end
実行すると、上記のプログラムは次の結果を生成します-
Hello, Ruby!
末尾のコメントがコードから十分に離れており、簡単に区別できることを確認してください。 ブロックに複数の末尾コメントが存在する場合、それらを揃えます。 たとえば-
@counter # keeps track times page has been hit
@siteCounter # keeps track of times all pages have been hit