もっとコメント論　～その５～　コードが求めるコメント

コメントは英語で書くべき？

プログラミングのコメントについて、何が何でも英語で書かなければならないと主張する人がいるらしい。

確かに、日本語は、環境によっては入力できないとか、正しく表示できないといった問題が起こる場合がある。しかし、少なくとも仕事で開発を行う場合には、そのような状況はほとんど考慮する必要はないだろう。

このような文字コード上の問題の他に、どうしても英語でなければならないという積極的な理由が何かあるだろうか？

ソースコードは読者に情報を伝えるための手段（メディア）である。

どんなメディアでも、情報の受け手が誰なのかということを想定するはずだ。そして、その時点で、どんな言葉や表現で伝えるべきかということは自ずと決まる。

ソースコードも例外ではない。「読者層」を想定し、その読者に最も適した言葉でコメントを書くべきだ。結果、英語になることもあれば、日本語になることもあるだろう（※）。

読者の立場に立つ

良いコメントとは、「読者が求めるコメント」である。コメントに限らず、ソースコード上手く書こうと思えば、常に読者の存在を意識し、読者の立場に立つことが必要だ。そのためには、まず、自分自身が読者としての経験を積むことが必要である。

しかし、その経験が不足しているプログラマは意外に多いようだ。特に、「直す不幸、直せない不幸」で述べたような「作り逃げ」の仕事ばかり続けていると、実務の中で、他人の書いたソースコードを読むという機会がなかなか得られない。

仕事でプログラマをやっていれば、周りには、他人の書いたソースコードが少なからずあるだろう。自分の作業に直接関係ないものであっても、積極的に読んでみるのもよいのではないだろうか。

コードが求めるコメント

ここまで、コメントについて長々と書いてきたが、ソースコードの主役は、あくまでもコード本体（プログラミング言語で書かれた部分）であることは忘れてはいけない。

まず、コメントを上手く書く以前に、コード自体を上手く書く必要があるのは、言うまでもない。決して、読みにくいコードをコメントで誤魔化すようなことがあってはならない。

そして、コメントはコードを生かすために書くべきである。良いコメントは、コードとマッチしていて、コードの邪魔をしたりしない。これは、つまり、コードの書き方によって、コメントの書き方が変わるということでもある。そういった意味では、「コードが求めるコメント」を書くべき、という言い方も出来るだろう。

例えば、プログラミング言語の特性によって、コメントの書き方は変わってくる。「バッチファイル」のような構造化しにくい言語と、Java のような例外処理まで備えたオブジェクト指向言語では、コードの書き方が全く違う。当然、コメントの書き方も違うものになるはずだ。

最後に

プログラミングにおいて、コメントをどう書くかということは、重要な問題だ。にもかかわらず、プログラミングの入門書や、企業の研修では、それほど重視されていないようである（他に学ぶべきことが多すぎるのだ）。プログラマは、良いコメントとはどのようなものかを、一度、自分で考えてみる必要がある。

そして、プログラミングを行う際には、より良いコメントを書くことを常に意識すべきだろう。例えば、自分のコードを見直すときには、コメントの書き方まで注意してみる。それだけでも、ずいぶん違ってくるのではないだろうか。

応援のクリックお願いします →