プログラムのコメント
朝、お客さまの報告を見ていて、
プログラマーだったころを思い出しました。
プログラムを書く時には、
コメントを書くことが推奨されています。
※いました。かも？
例えば、
プログラムに書いた処理の説明を書くことがあります。
=====
関数○○○○
この関数は○○という処理をするためのものです。
データベースに××のデータを・・・
=====
例えば、
プログラムを書いた理由を書くことがあります。
=====
△△で□□という処理をしているため、
あえて修正しない
=====
将来見る人のため
こういったコメントをわざわざ書きます。
何のために書くかというと、
「将来、修正が必要な時のため」
「将来、見る人のため」
です。
特に
プログラムを書いた理由は残しておかないと
見たときにプログラムを理解できません。
自分が書いたプログラムでも思い出すのに時間がかかります。
だから、忙しくても、ちゃんと、
コメントを残すよう指導されました。
でもね、忙しいと
コメントもおざなりになったりします。
コメントを書く時間があったら、
プログラムをもっと書きたいし、
早く家に帰りたい。
その結果がどうなるか。
たぶん、ご想像の通り。
将来、自分が見るときに困るんです。
結局は自分に返ってくる
そして、
将来見るのが、自分とは限りません。
自分で見てもわからないのに、
他人が見たらわかるはずがありません。
で、
結局、自分に連絡が来ます。
そうなると、結局自分の時間がとられます。
だからこそ、コメント！
大事なんです。
プログラムに限らないと思います。
いつか見る誰かのために。
ちょっとだけ手間をかけられたら。
という話。