コメントを記述する

Perl のプログラムの中に、この部分はどんな目的でプログラムを記述していたかなどのコメントを記述することができます。コメントはプログラムの実行時には無視されるので、コメントの書式に従って記述しておけばプログラムの実行内容に何も影響しません。ここでは Perl のプログラムの中でコメントを記述する方法について解説します。

(Last modified: 2023年03月20日)

コメントを記述する
複数行に渡るコメントを記述する
PODをコメントの代わりに記述する

コメントを記述する

Perl でプログラムの中にコメントを記述するには # のあとに記述します。

#コメント

文の中で # が現れるとそれより右側の文末まではすべてコメントとなります。 # は文の先頭に記述しその行をすべてコメントとしてもいいですし、文の途中で記述してその位置より右側をコメントとしてもいいです。

# Disp Fruit Name

print "Orange\n";  # Orange
print "Melon\n";
print "Lemon\n";

コメントはプログラムの実行時には無視されますので次のように記述したものと同じと解釈されます。

print "Orange\n";
print "Melon\n";
print "Lemon\n";

複数行に渡るコメントを記述する

Perl では他のプログラミング言語のように複数行にわたってコメントを記述するための仕組みは用意されていません。その為、複数行にわたるコメントを記述する場合は、 1 行ずつ行の先頭に # を記述してコメントにする必要があります。

次の例をみてください。

# Disp Fruit Name
#      2023/01/22
#      by Sakusha

print "Orange\n";  # Orange
print "Melon\n";
print "Lemon\n";

プログラムの先頭 3 行がコメントとなっています。

PODをコメントの代わりに記述する

Perl ではコメントを書く場合には # しか用意されていません。ただ、コメントではないけれどコメントと同じようにプログラムの実行に影響を与えずに文字列を記述する方法があります。

POD(Plain Old Documentation) は Perl のプログラム中に(コメントよりも複雑なことが記述できる)ドキュメントを記述するための形式です。 POD 形式で記述されたドキュメントは別途用意されたコマンドを使ってドキュメントを整形して取り出す事ができます。( Java で言うところの Javadoc のようなものです)。

POD もコメントと同じようにプログラムに記述でき、プログラムの実行には影響を与えませんのでコメントの代わりに POD 形式でコメントとなる文章を記述することができます。

=pod
コメント
コメント
コメント
=cut

=pod から =cut までの間に記述されている内容についてはプログラムは何も行いません。

次の例をみてください。

=pod
Disp Fruit Name
     2023/01/22
     by Sakusha
=cut

print "Orange\n";  # Orange
print "Melon\n";
print "Lemon\n";

=pod から =cut までの文はプログラムの実行時には無視されるのでコメントのように記述することができます。

純粋なコメントを記述する為には複数行であっても # を使った方がいいと思いますが、プログラムの一部分などをデバック中にコメントにしたりする場合には覚えておくと便利です。

サンプルコード

それでは簡単なサンプルを作成します。

=pod
サンプルプログラム
2023/03/20
=cut
print "Orange\n";  #Orange
print "Melon\n";   #Melon
print "Lemon\n";   #Lemon

テキストエディタでプログラムを記述したあと sample.pl という名前で保存します。(文字コードは UTF-8 です)。コマンドプロンプトを起動し、プログラムを保存したディレクトリへ移動したあとで次のように実行します。

perl sample.pl

次のように実行結果が表示されます。

コメントを記述する(1)

# を使ったコメントと、 POD を使ったコメントをそれぞれプログラムの中に記述しました。コメントは実行時には無視されるので、プログラムの実行結果には影響しません。

-- --

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

( Written by Tatsuo Ikura )

著者 / TATSUO IKURA

これから IT 関連の知識を学ばれる方を対象に、色々な言語でのプログラミング方法や関連する技術、開発環境構築などに関する解説サイトを運営しています。