Maintenance 代码维护,替换代码

Maintenance 代码维护,替换代码,maintenance,Maintenance,如果我正在维护一个代码库,并且想要替换一些代码,我是否应该删除它,对更改和替换原因发表评论,然后实现新代码?或者我应该注释掉我要替换的代码部分,说明原因并放入新代码?我可以看到,当你为了内存而牺牲速度时,你也可以这样做,反之亦然,但是在其他情况下,建议使用后者吗?你可能应该删除旧代码,然后添加新代码。只有当新代码本身应该被注释时,才应该在代码中添加注释。在版本控制系统和任务/问题跟踪器的注释消息中,说明删除了哪些内容、添加了哪些内容以及为什么要添加这些内容。以下是我的建议: 假设这是正确的版本控

如果我正在维护一个代码库,并且想要替换一些代码,我是否应该删除它,对更改和替换原因发表评论,然后实现新代码?或者我应该注释掉我要替换的代码部分,说明原因并放入新代码?我可以看到,当你为了内存而牺牲速度时,你也可以这样做,反之亦然,但是在其他情况下,建议使用后者吗?

你可能应该删除旧代码,然后添加新代码。只有当新代码本身应该被注释时,才应该在代码中添加注释。在版本控制系统和任务/问题跟踪器的注释消息中,说明删除了哪些内容、添加了哪些内容以及为什么要添加这些内容。

以下是我的建议:

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

  • 如果可能的话,让代码自我记录,而不是把注释放在那里解释

  • 如果您有版本控制,我不建议注释掉代码,因为它可能不会被清理,并且让猜测工作留给以后的任何人。他们可能会认为这段代码被注释掉是有原因的

  • 确保在提交之前对所有代码进行了正确测试


  • 这个问题的问题是我们不知道代码是什么,如果你只是在重构或重写一些会改变api的东西,如果代码是库的一部分或应用程序的主代码,如果你是否使用vcs。。。尽管有这么多未知点,你还是希望得到一个建议吗?我没有考虑版本控制,我经常忘记这一点。没有版本控制,所以我将为此设置一些内容。然后我会担心更新它。谢谢你的帮助。