KL system

コメントを書こう

by 唐草 [2023/04/21]

　多くのプログラム言語には「コメント」と呼ばれる機能が用意されている。これはプログラムのソースコードに注釈を書き加えるためのもので、プログラムの実行には何の影響もない。基本的にソースコードを読む人間の理解を助けるものだ。現実に例えるのなら、書きかけの原稿用紙に貼られたメモ書き付箋のようなものと言える。
　言語の使用上、コメントにはどんなことでも書ける。プログラマのあるあるネタに「なぜ動くかわからない」というコメントを見て恐怖したという怪談とも笑い話とも取れる鉄板ネタがある。コメントは、それぐらい自由に書けるものなのだ。
　とは言え、一般的には関数の使い方や著作権情報を記載することが推奨されている。言語や開発ツールによっては、規定の書式でコメントを書くと自動的にドキュメントを生成してくれる便利なものもある。
　先にも書いたようにコメントは、プログラムの理解を助けるために用いられるので大人数での開発には欠かせない存在となっている。もしコメントがなければ、プロジェクトに関わる全員がソースコードを1行1行読み解いてどんな処理が実行されるのか理解しなくてはならない。
　自分が書いたソースコードでさえ数ヶ月もすれば中身を忘れて理解に苦しむこともある。正直言って自分が書いたとは思えないことも珍しくない。ましてや他人が書いたものを理解するのは不可能に近い。他人から引き継いだソースコードにコメントがないときの絶望感は、言葉が通じる人が一人もいない場所に放り込まれたときのようなもの。
　一人でプログラムを書いているプログラマでもコメントは必ず書いていることだろう。多くは数週間後の自分のために書いているはず。それは未来の自分への助け舟みたいなものだ。
　一人で仕事に取り組むぼくのプログラムにも多数のコメントが書かれている。もちろん未来の自分に託すメモという意味合いもあるが、それは二次的なもの。ぼくがコメントを書くのはソースコードを書く前。「今からここにこういう処理を書くぞ」と自分に言い聞かせるのが主な目的だ。
　ぼくにとってコメントは覚悟の証。

• <<前の記事を読む　
• 　次の記事を読む>>