maintenance - 代码维护，更换代码

Question

如果我正在维护一个代码库并想要替换一些代码，我是否应该删除它，对更改以及它被替换的原因发表评论，然后实施新代码？或者我应该注释掉我要替换的代码部分，说明原因并放入新代码？当您牺牲内存速度时，我可以看到执行后者，反之亦然，但是是否有其他情况推荐使用后者？

Answer 1

您可能应该只删除旧代码并放入新代码。只有当新代码本身应该被注释时，你才应该在代码中添加注释。在您的版本控制系统和任务/问题跟踪器中的评论消息中描述删除的内容、添加的内容以及原因。

Answer 2

这些是我的建议：

1. 假设这是正确的版本控制，您应该只替换代码。这就是版本控制系统的美妙之处，您可以回滚到以前的更改。

2. 如果可能的话，让代码自我记录，而不是在里面放注释来解释。

3. 如果您有版本控制，我不建议注释掉代码，因为它可能不会被清理，并且以后任何人都可以猜测。他们可能会认为代码被注释掉是有原因的。

4. 确保您的所有代码在提交之前都经过正确测试。