「変更した部分はコメントアウトして残す」必要がある場合

「もうやらなくていい昔のコーディングテクニックあれこれ」のコメントを見ていて、以下の記述が気になった。

変更した部分はコメントアウトして残すこと。

僕は普段Subversionを使っているので変更した部分は不要だと思っていたが、最近場合によっては残した方が良いと考え方が変わった。

それは、開発する場所が別でSubversionのサーバを別に用意している場合だ。

SubversionでもCSVでも良いが使っていると当然、変更履歴を見ることが出来る。履歴を探すのが意外と大変だったりもするが便利な機能である。

ところがサーバが別だと当然管理が別なので変更履歴も別となる。開発段階ではオフショアとかで開発拠点が別にあることは多々ある。そんな場合に役に立つのがコメントとして残してある変更履歴である。

また、拡張して数行だけ追加した場合も「ここから追加」みたいなコメントが書いてあると重宝する。

変更履歴のコメントは基本的にいらないと思うが時と場合によっては、コメントを残しておくことは重要である。と思う。