代码维护，替换代码

Question

如果我维护代码库并想要替换某些代码，我应该只擦除它，对变更进行评论以及替换原因，并实现新代码？或者我应该注释掉我要替换的那部分代码，说明原因并将新代码放入？当你为记忆牺牲速度时，我可以看到后者，反之亦然，但在其他情况下，推荐后者吗？

Answer 1

这是我的建议：

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

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

3. 如果您有版本控制，我不建议您评论这些代码，因为它可能不会被清理干净，并在以后为任何人留下猜测工作。他们可能会认为该代码被注释掉的原因是有原因的。

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

Answer 2

您可能应该删除旧代码并添加新代码。只有新代码应该自己评论时，您才应该在代码中添加注释。在您的版本控制系统和您的任务/问题跟踪器中，已删除内容，已添加内容以及为什么应在评论消息中的描述。