10月 10, 2008
admin

コメントと改行のちょっといい話

プログラムのソースコードの中には、「コメント」というものがあります。直接コンピュータが「実行しない」注釈のことで、実行時には無視されます。

では、この「コメント」は盲腸のような「あってもなくてもよい」ものなのか、と言われれば……さにあらず。とても大事な働きをするものです。しかも、プログラムの実行時にではなく、人がプログラムを読んだり書いたりするときに、です。

そもそもプログラミング言語は人の言語そのものでないため、「だいたいこういうことをやっている」という「注釈」を入れておくと分りやすくなります(=入れないと分りにくくなります)。たとえ、プログラムを組んだ直後は内容を覚えていたとしても、1日や2日もたてば(私は1晩もたつと)こまかい内容など忘れてしまうものなので、「これはどういう内容だったんだろう?」と、自分の組んだプログラムを前に頭を抱えてしまうこと請け合いです。

そこで、当時の記憶を呼び覚ます手がかりになる「注釈」や、プログラムの処理内容を把握しやすくするための「注釈」を入れておこうということになります。だいたい、どのプログラミング言語でもコメントが書けるようになっており、コメントをサポートしていないプログラミング言語にはお目にかかったことがありません(もしかしたら、広い世の中のどこかにはあるのかもしれませんが……)。

普段から他人に読ませることを前提にプログラムを書くよう習慣をつけているので、とてもコメントなしでプログラムなんか書けません(書ける人もいますが、なるべく一緒に仕事をしたくありません)。かといって、1行ごとにコメントをつければ分りやすくなるというものでもありません。「節度あるコメント量」とでもいうべきものがあって、それはなかなかに説明しづらい種類のものなのです。

 

しかも、海外のプログラマーがつけるコメントは、さすがに言葉が違うだけあって、趣きがずいぶんと異なります。たとえ英語でコメントが書かれていたとしても、日本人のコメントのほうが分りやすいように思うのは、「日本人同士だから」なのでしょうか。 

 

コメントと似たもので、同じような働きをするものに「改行」があります。プログラムの意味的な区切りがついた場所に、あえて空(から)の改行を入れておくのです。その内容が重要であれば、コメントも付けたりしておきますが、コメントをつけるまでもない場合には、区切りで改行を入れています。

■コメントの入っていないプログラム

○○○○○○○

○○○○

○○○○○

○○○○

○○○○○

■コメントと改行が入ったプログラム

–ここで例外処理

○○○○○○○

○○○○

○○○○○

○○○○

○○○○○

いかがでしょう。雰囲気だけでもお分かりいただけたでしょうか?(N)

Leave a comment