maintenance - コードの保守、コードの置き換え

Question

コード ベースを保守していて、一部のコードを置き換えたい場合、そのコードを消去し、変更内容と置き換えられた理由についてコメントし、新しいコードを実装する必要がありますか? または、置き換えているコードのセクションをコメントアウトし、その理由を述べて、新しいコードを挿入する必要がありますか? メモリの速度を犠牲にしている場合、またはその逆の場合に後者を実行することがわかりますが、後者が推奨される他の状況はありますか?

Answer 1

おそらく、古いコードを削除して新しいコードを挿入する必要があります。新しいコード自体にコメントを付ける必要がある場合にのみ、コードにコメントを追加してください。削除されたもの、追加されたもの、およびその理由の説明は、バージョン管理システムとタスク/課題トラッカーのコメント メッセージに記載する必要があります。

Answer 2

これらは私の推奨事項です：

1. これが適切にバージョン管理されていると仮定すると、コードを置き換えるだけです。これがバージョン管理システムの優れた点です。以前の変更にロールバックできます。

2. 可能であれば、説明のためにコメントを入れるのではなく、コードを自己文書化してください。

3. バージョン管理がある場合は、コードをコメントアウトすることはお勧めしません。おそらくクリーンアップされず、後で誰かに推測作業が残されるためです。彼らはおそらく、そのコードがコメントアウトされている理由があると考えるでしょう。

4. コミットする前に、すべてのコードが適切にテストされていることを確認してください。