修正履歴
受託開発担当のRyuです。
以下のような修正履歴として記述されたコメントを見たことがあるでしょうか?
// 修正履歴 // 20XX/01/10 ○○修正 // 20XX/02/20 ○○修正 // 20XX/02/20 修正者:○○ // 修正前のコードをコメントアウトしたもの // for(...) { // // } for(...) { }
元は責任の所在や今後また利用するかもしれないという考えから残されるようになったであろうこれらのコメントは、現在ではほぼ不要となっています。
なぜならこれらの情報は全て、svn、cvs、vssなどのバージョン管理システムが保持しています。
バージョン管理システムを導入していない現場は、現在ではそう多くないでしょう。
これらのコメントはその後不要になる場合が多いのですが、修正した当人以外は触ることができなくなってしまい、いつまでも不要なコメントとして残り続け、ソースコードの可読性を低下させてしまいます。
開発現場によってはコーディング規約に「リリース前のコードであろうと修正したコードの履歴は、コメントとして残さなければならない」というものがあり、ソースコードの8割がコメントで埋められていることもあるそうです。
バージョン管理システムを利用しているときは、「// ○○年○月○日 修正者:○○」等のコメントや、修正前のソースコードをコメントアウトしたものを残すべきではないでしょう。
規約等で未だにこれらをコメントを残さなければならない開発現場も多数ありますが、今後改善されていることを切に願います。