Rubyのコメント入門｜単一行コメントと複数行コメントの書き方

コメントはプログラムの中に書くメモのようなもので、実行時には無視されます。コードの意味を説明したり、一時的にコードを無効化するときに使います。Rubyには単一行コメントと複数行コメントの2種類があり、それぞれの使い方を理解しておくことで、読みやすいコードを書けるようになります。

基本的な使い方

Rubyでは#記号を使って単一行コメントを書きます。#以降、その行の終わりまでがコメントとして扱われ、実行時には無視されます。

Ruby

# これはコメントです（実行されません）
puts 'Hello'  # 行の途中からもコメントを書ける

# 変数の初期化
name = 'Ruby'
puts name

実行結果

Hello
Ruby

#はコードの先頭にも、コードの後ろにも書くことができます。コードの後ろに書く場合は、コードとコメントの間にスペースを2つ入れるのが一般的なスタイルです。コメント部分は完全に無視されるため、実行結果には影響しません。

複数行にわたるコメントを書きたい場合は、=beginと=endで囲みます。この間のすべての行がコメントとして扱われます。

Ruby

=begin
ここは複数行コメントです。
何行でも書くことができます。
実行時にはすべて無視されます。
=end

puts '複数行コメントの外なので実行されます'

実行結果

複数行コメントの外なので実行されます

=beginと=endは必ず行の先頭に書く必要があります。インデントを入れると正しく認識されないため注意が必要です。実際の開発現場では複数行コメントはあまり使われず、各行に#を付ける方法が主流です。

複雑な処理やビジネスロジックの意図を説明するためにコメントを活用します。「何をしているか」ではなく「なぜそうしているか」を書くと、より有用なコメントになります。

Ruby

# 税込価格を計算する
# 小数点以下は切り捨てて整数にする（会計ルールに従う）
price = 1980
tax_rate = 0.10
total = (price * (1 + tax_rate)).floor

puts "税込価格: #{total}円"

実行結果

税込価格: 2178円

デバッグ中にコードを一時的に無効にしたい場合、削除せずにコメントにすることを「コメントアウト」と呼びます。

Ruby

puts '処理1を実行'
# puts '処理2を実行'  # 一時的に無効化
puts '処理3を実行'

実行結果

処理1を実行
処理3を実行

コメントアウトはデバッグの際に非常に便利です。コードを削除してしまうと元に戻せませんが、コメントアウトなら#を外すだけで簡単に復元できます。

良いコメントの書き方

コメントは「なぜ（Why）」を書くことが重要です。# iに1を足すのようなコードを見ればわかることではなく、# 配列のインデックスは0始まりのため、表示用に1を足すのように意図を説明しましょう。

=begin / =end の注意点

=beginと=endは必ず行の先頭（インデントなし）に書いてください。スペースやタブが前にあると、コメントとして認識されずにエラーになります。