質問内容

プログラムにおけるコメントの目的

関連キーワード

クラスコメント, ブロックコメント, インラインコメント

回答

プログラムを書く人で、よく多いのがプログラムにコメントを全く書かない又は殆ど書かない人です。
たぶん、そのような人はせっかちな人か、コメントを書く時間がもったいないと考えている人なのかもしれません。
　
しかし、コメントを書くことが時間がもったいないといえるのでしょうか？
プログラムにも、人間と同じく一生というものがあります。プログラムを書き終わった段階はまだ人間でいう幼稚園位の時期です。
書いたばかりのプログラムには、これから単体テスト、結合テスト、総合テスト、運用、バージョンアップによる改変など様々なイベントが待っています。
システムによって大きく違いますが、プログラムの寿命が10年以上に及ぶものもあります。
　
そして、そのような長いプログラムの一生の中で、そのプログラムを見る人も移り変わっていきます。
コメントがないプログラムが、次の人にバトンタッチされた時、得てして次の人はこのように叫び途方に暮れることになります。
「このロジックって一体どういう意味があるんだろう？」
と。
　
更に悪いことに、コメントを書かない人はプログラムをより短く書くことにエクスタシーを感じる人が多く、そのトリッキー(奇怪)なプログラムによって、次の人の悩みを更に深くさせます。
　
コメントを書くことは、自分のためではありません(自分のためでもあるのですが...)。プログラムが自分の物ではない以上、そのプログラムは何の目的で書かれているか、どういう考えで書かれたのかを説明して他の開発メンバーと共有しやすくする義務があるのです。
　
(続く...)
　

関連記事

import文の書き方の注意点 入力チェックをどう実装するか ドキュメントの目的 JavaとJavaScriptの違い Javaとは Java・システム開発なんでもQ&A