コメントを記述する

プログラムの中に作者や作成日、コードに関する注記などメモを残しておきたい場合はコメントを記述することができます。コメントを記述する場合は決められた方法で記述する必要があります。ここでは Ruby のプログラムの中でコメントを記述する方法について解説します。

(Last modified: 2023年02月24日)

コメントを記述する

Ruby のプログラムの中でコメントを記述するには次の書式を使います。

#コメント

プログラムの中で # が記述されていた場合は、 # から行末までがすべてコメントとなります。コメントは実行時には無視されます。例えば次のように使います。

# 作成日 2022.10.21

puts("Hello")   # 画面に出力します

上記の場合、二箇所にコメントが記述されています。行の先頭に # が記述されていた場合は行全体がコメントなります。またコメントは式のあとなどにも記述することができます。その場合は # から行末までがコメントとなります。

プログラムの実行時にはコメント部分は無視されますので、次のようにプログラムが記述されたのと同じことです。

puts("Hello")

このようにコメントを記述しておくことで、プログラムがどのような意図で作成されたのかメモを残しておくことができます。

埋め込みドキュメント

コメントは # から行末までがコメントとなりますので、複数行にまたがってコメントを記述することは出来ません。ただし、次の書式を使うことで複数行のコメントを記述することができます。

=begin
ドキュメント
ドキュメント
ドキュメント
=end

これは埋め込みドキュメントと呼ばれるものでプログラム中にドキュメントを記述する際に利用されます。コメントではありませんが =begin から =end までに記述された行は実行時には無視されますのでコメントの代わりに使うこともできます。

=begin と =end は行の先頭に記述する必要がありますので注意して下さい。例えば次のように使用します。

=begin
プログラム作成日時：2022年10月21日
作成者：xxxx
=end

puts("Hello")

なおコメントを使用する場合も各行の先頭に # を付ければ同じようなことができます。

#プログラム作成日時：2022年10月21日
#作成者：xxxx

puts("Hello")

埋め込みドキュメントを使ったコメントの記述は本来の使用目的とは異なるので、使用は避けたほうがいいかもしれません。

-- --

Ruby のプログラムの中でコメントを記述する方法について解説しました。

著者 / TATSUO IKURA

プログラミングや開発環境構築の解説サイトを運営しています。