【Ruby入門】Rubyのコメントの書き方

今回はRubyでのコメントの書き方を解説していきます。

コメント

コメントはコードを読み解く際、とても重要なものとなります。

長いコードになればなるほど、逐一コードを読んで理解するには、コメントが必要となります。

特に、複数の人数でコーディングをするときには、コメントが必須です。

コメントの書き方

Rubyにおけるコメントの書き方は以下のようになります。

#コメント

「#」の後は行末までがコメントとなり、実行されることはありません。

ただし、文字列中などに含まれる場合を除きます。

複数行コメントの書き方。

複数行コメントを挿入したい場合、以下のような書き方をすると複数行のコメントが楽にかけます。

=begin
どうも こんにちは
MILKMANだよ
ここはコメントだよ
=end

上記の例は、埋め込みドキュメントと呼ばれ、「=begin」〜「=end」までの行がコメントと同じ扱いになります。

埋め込みドキュメントの中身は自由に表記できます。

#どうも こんにちは
#MILKMANだよ
#ここはコメントだよ

また、「#」で書くとこのような書き方になります。

__END__

「__END__」を書き込むと、それ以降の行すべてがコメント扱いとなります。

__END__
ここから下の行すべてはコメントです。

例

以上のコメントの書き方の例です。

=begin
20xx/01/01
コメントの使い方の例
=end

puts "MILKMAN" #表示される

__END__
以上が例でした。

実行結果は以下のようになります。

MILKMAN

上記の例は詰め込みすぎてしまった感じが否めませんが、コメントを上手く使って、わかりやすいコードにしましょう。