代码维护,替换代码

时间:2013-02-14 06:22:10

标签: maintenance

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

2 个答案:

答案 0 :(得分:1)

您可能应该删除旧代码并添加新代码。只有在新代码本身应该被注释时,才应该在代码中添加注释。在您的版本控制系统和任务/问题跟踪器中,删除内容,添加内容以及为什么应该在评论消息中进行说明。

答案 1 :(得分:0)

这些是我的建议:

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

  2. 如果可能的话,让代码自我记录,而不是在那里放置评论来解释。

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

  4. 确保在提交之前对所有代码进行了适当的测试。