コメントの記述

プログラムの中に記述されたものは順に実行されていきますので、プログラムの中に好きなようにメモなどを記述しておくことは出来ません。記述したメモも実行しようとしてエラーとなってしまうためです。ただこの記述が何をしているのかなどをプログラム中に記述しておくことと、プログラムを後で読み返したときに便利です。

このような場合にはコメントを記述することが可能です。コメントはプログラムの中に記述しますが実行はされませんので好きな文書を記述しておくことが出来ます。

コメントを記述するには次の書式を使います。

#コメント

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

# 作成日 2008.06.11

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

上記の場合、二箇所にコメントが記述されています。行の先頭に「#」が記述されていた場合は行全体がコメントなります。また他の処理を記述した後に「#」を記述した場合には「#」から行末までがコメントとなります。

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

print("Hello")

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

埋め込みドキュメント

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

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

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

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

=begin
プログラム作成日時：2007年4月25日
作成者：xxxx
=end

print("Hello")

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

#プログラム作成日時：2007年4月25日
#作成者：xxxx

print("Hello")

本来の使用目的とは異なるので使用は避けたほうがいいかもしれません。

RubyLife