プログラム中にコメントを入れたり、一時的にある行のコードをコメントにして実行されないようにすることができます(そのことを「コメントアウトする」と言います)。
ここでは、Ruby におけるコメントの書き方・コメントアウトの方法を解説していきます。
目次
コメントとは?
コメントは、プログラムの実行に影響しない部分のメモ書きのことです。
人間があとからプログラムを見たときの注釈として、自由にメモを記述しておくことができます。
また、エラー調査やデバッグを行うために、一時的に ある行のプログラムをコメントにして、実行されないようにする用途で使うこともあります。
プログラムをコメントにすることを「コメントアウトする」とも言います。
特定の1行をコメントにする(# の使い方)
#
を使うと、特定の1行をコメントにすることができます。
以下のコードを例にして解説していきます。
コード例
print 'ABC'
print 123
プログラムの実行結果
ABC123
上のプログラムの1行目をコメントにしてみましょう。すると、以下のようになります。
1行目をコメントにしたコード例
# print 'ABC'
print 123
プログラムの実行結果
123
「ABC」の出力は行われず、「123」のみが表示されました。
このように #
をつけることで、その行の以降のコードは実行されなくなります。
また、#
の手前のコードは通常通り実行されるので、以下のようにすると特定の行にコメントを書き加えられます。
コメントを加えたコード例
print 'ABC' # ABCを出力
print 123 # 123を出力
プログラムの実行結果
ABC123
複数行をまとめてコメントにする(=begin や =end の使い方)
=begin
と =end
で囲むと、複数行をまとめてコメントにすることができます。
以下のコードを例にして解説していきます。
コード例
print 'ABC'
print 'DEF'
print 123
プログラムの実行結果
ABCDEF123
上のプログラムの1〜2行目をコメントにしてみましょう。すると、以下のようになります。
1〜2行目をコメントにしたコード例
=begin
print 'ABC'
print 'DEF'
=end
print 123
プログラムの実行結果
123
「ABC」や「DEF」の出力は行われず、「123」のみが表示されました。
以降の行をすべてコメントにする(__END__ の使い方)
__END__
を使うと、その行以降をすべてコメントにすることができます。
以下のコードを例にして解説していきます。
コード例
print 'ABC'
print 'DEF'
print 123
プログラムの実行結果
ABCDEF123
上のプログラムの2行目以降をすべてコメントにしてみましょう。すると、以下のようになります。
2行目以降をコメントにしたコード例
print 'ABC'
__END__
print 'DEF'
print 123
プログラムの実行結果
ABC
「DEF」や「123」の出力は行われず、「ABC」のみが表示されました。
まとめ
以上、Ruby におけるコメントの書き方・コメントアウトの方法でした!
ここまでの内容をまとめておきます。
- 「コメント」は、プログラムの実行に影響しない部分のメモ書きのこと。
#
を使うと、特定の1行をコメントにすることができる。=begin
と=end
で囲むと、複数行をまとめてコメントにすることができる。__END__
を使うと、その行以降をすべてコメントにすることができる。