プログラミング コラム

コメントを書く意味

コメントとは、処理を行わないテキスト部分のことです。
プログラムを習い始めた時から、いつの間にか意識せずとも使うようになっている、馴染み深いものかと思います。

その使い方は様々ですが、意味のある使い方を出来ているでしょうか。

ウェブブラウザで動くサイトのページ内もHTMLという言語で書かれており、やはりコメントは使用できます。そして、HTMLは誰でもコード部分を見ることが出来ます。
一昔前は見られることを前提に、コメントで企業のキャッチコピーを埋め込んでいたこともありました。
マーケティングという意味では面白い使い方ですが、プログラマー視点では意味はありません。

また、ここの処理は今は不要だが、後からまた使ったり参考にしたりするためにメモとして残しておきたい、という場合にもコメントにするケースもあります。
ただ、現在ではGitなどのバージョン管理システムが普及していることもあり、削除したとしても記録に残るので、後から見返せます。
コード量の削減は処理の見通しが良くなったり、リソースとしてコードをダウンロードする際にも通信量の削減ともなるので、コメントでメモとして残すことは忌避されつつあるのが現状です。

コンパイルを行わなければならない言語ではコメントは最終的には削除されてしまうので、ユーザーが目にすることはありません。
それを知ってか知らずか、過密スケジュールを押し付けてくる上司への呪いのコメントもあったとか。
笑い話としては面白いですが、もちろんこのようなコメントはすべきではありません。

コメントを全く使用しないケースもあるようです。
使用しない理由は、記述する時間が惜しい、そもそも習慣がない、と様々でしょう。
ですが、時間が惜しいと言うなら、むしろ積極的に複雑な処理や変数、関数の説明としてコメントを活用することをお勧めします。
今は苦しくとも、後日、忘れてしまった処理の意味を一目で把握でき、その時に大幅な時間短縮となります。
むしろ、これらのコメントがないから、コメントする暇もなくなる、という悪循環の一因となっていることすらあり得ます。

コメントの役割は今後も変化していくと思われますが、意味のある役割としてコメントを使用できるかどうかは、プログラマーの意識次第でしょう。
普段何気なく記述しているコメント。
この機会に、一度振り返ってみてはどうでしょうか。
written by Takahiro Tokunaga / 2022.11.17
コラム一覧