コード変更時にはコメントも変更しよう
ソースコードにおけるコメントの書き方を書こうと思ったんだけど、過去に言いたいことを全て書いていたので、最後に関連記事へのリンクをはりました。
これだけだとつまらないので。:)
上記記事に対してコード修正時はコメントも変更すべしということを追加したいと思います。
ソースコードを変更したら、コメントも変更するべきなのですが、これはなかなか行われないことが多いです。コメントは修正してもしなくても、Syntax errorにはならないですからね。私も出来ていないことが多いです。
しかしながら、コメントと実際の内容が違っていると、厄介なことが多いのです。時には判断に困ることも。最終的にはロジックのみが真実であることになってしまっていないでしょうか。それではコメントを書く意味がありません。
一つにはコメントを変更しなくてもコンパイルエラーとならないことに問題がありますが、それを解決するのは容易ではありません。現在の技術では、やはりプログラマ次第ということになるでしょう。できるだけコメントも同時に修正するよう心掛けたいと思います。
過去の関連記事:
yasuhoの隠れ家 - プログラミングにおけるコメントの付け方について