コードにコメントをつけることがダメなケース 更新が追いついていない

2021年6月14日

例えば以下のようなコメントがあったとします。

// ここでのurlは、テスト環境ではhttp://tamibouz.com/test 本番環境では http://tamibouz.com/prod です。

補足のため非常に親切なように見えますが、このような情報をコードに埋め込んでしまうと、いざurlが変わったときにコメントを更新し忘れることが多々あります。

そして、嘘の情報をみた開発者が時間を無駄にします。

コメントを書くときは、変更があったときにそのコメントも同時に更新しなくてはいけないことに気付けるか、という観点を持つと良いです。