わたしのブログ

・コメントの間違った利用法

しかし、本来プログラムを読めばわかるようなことについてまで、コメントを書く必要はありません。

同じように、プログラムを読めばわかるようなことを、プログラムとは別のドキュメントに細かく書き残す必要はありません。

そうであるにもかかわらず、なぜ相変わらずコメントを書くことや、ソースコードとは別のドキュメントにプログラムの詳細を書くことが続けれているのでしょうか。

このような人はいるんですが、む～ん・・・・。

現実の開発では、もともと他人が読む事を意識せず、読みやすさを考慮せずにソースコードを書いているので、そのソースコードを他人が理解するための主たる手段としてコメントを書いたり、ドキュメントを書いたりしている場合もかなり多いのではないかと思います。

そして、そのようなコメントやドキュメントを書く主な理由は、「後の保守のため」だと思い込んで、書いている場合も多いと思います。

ところが、後にいざ保守しようとしたとき、ドキュメントを読んでも不明な点があれば、結局は必ずソースコードを読むことになります。

しかし、多くの場合、そのソースコード自体が読みやすくわかりやすく書かれていないため、非常に苦労することになるのです。

結局、ソースコードでの理解が必要となりますね。あとは、理解して知っている人に聞くのも有りですね。人によって、ずいぶんとソースコードやドキュメントの書き方も違うのです。

では、また今度。