タグ: プログラム

プログラミングはソースコードとして一つの機能を実現させるための手順書を記述するものです。
しかし、作成した本人でさえ どのような処理をしているかをコメントとして記述しておかなければ、容易に理解できないものです。
もし作成した直後であれば、様々なことが記憶に残っているので、このような問題に至らないのですが、しばらく時間を置いてから処理(ソースコード)を追いかける場合は、コメントがなければ必ず苦労することになります。
ましてや、他の開発者のものであれば、コメントがなければ、実に大変なおもいをすることになるでしょう。
さらに、そのソースコードに修正を加えていくことは、考えただけでも遠慮したくなるに違いありません。
以上のことから、コメントは自分にとっても、開発者にとっても重要で、プログラムの処理の流れを把握/理解するための仕様書といえます。

仕様書は、プログラムの保守、機能拡張を行うときに参考にします。しかし、最終的には何を見るかというと、やはりプログラムです。
仕様書などは時としてプログラムの更新と同期していないことがありますが、プログラムは唯一真実を語るものです。
したがいまして、プログラムには仕様が明記されていなければならないのです。
仕様書よりは有効な開発支援となるものですから、必ずコメントを記述しています。（日本語で記述しています）
ヘッダー部は、プログラムが使用されなくなるまでソースプログラムについてまわるものなのです。

プログラムは文章とよく似たものです。きれいな文章は読む人に感慨を与え、また理解されやすいですね。
“きれいなプログラム” すなわち、体裁が整っている論理的なプログラムは、机上デバックでテストしやすいので、おのずと不良を見つけやすく、後々の保守作業や機能拡張の場合も無理なく行うことができるのです。