评论已删除的代码

评论被删除的代码是一个好习惯吗？例如:

// Code to do {task} was removed by Ajahn on 10/10/08 because {reason}.

在同行评审期间,我的开发人员小组中有人发表了一条说明,我们应该评论要删除的代码行.我认为这是一个可怕的建议,因为它用无用的评论使代码混乱.我们哪一个是对的？

1> David Koelle..：

---

一般来说,删除的代码不应该被注释,正是因为它使代码库混乱(并且,为什么会对不存在的东西发表评论？).

您的缺陷跟踪系统或源代码管理工具是此类评论所属的位置.

---

但是,在某些情况下,你会说"我删除了因为这个而应该去的地方",特别是如果它不直观的话.然而,这些情况非常少见.

2> buti-oxa..：

---

在注释代码(而不是删除)时,有一些(罕见的)情况是个好主意.这是一个.

我有一行似乎很好且必要的代码.后来我意识到这是不必要和有害的.我没有删除该行,而是对其进行了评论,并添加了另一条评论:"下面的行是错误的,因为这样的原因".为什么？

因为我确信代码的下一个读者会首先认为没有这行是一个错误,并会尝试将其添加回来.(即使读者是我两年后的.)我不指望他先咨询源代码控制.我需要添加评论来警告他这种棘手的情况; 并且错误的行和错误的原因恰好是最好的方法.

---

为什么不包括对单元测试中导致的线路损坏行为的测试？

3> Avi..：

---

我同意在评论中删除代码并不是一个好主意.

应该通过版本控制系统查看代码历史记录,该系统可以找到旧代码,以及删除它的原因.

4> Marko..：

---

您应该始终删除代码.

至于能够看到旧的/删除的代码,那就是修改控制.

5> Nir..：

---

取决于删除的原因.

我认为评论是人们在将来维护代码的提示,如果代码在那里但被删除的信息可能对维护代码的人有帮助(可能是"不要做那个"标志)那么应该在那里.

否则,在每次代码更改时添加名称和日期的详细注释只会使整个事情变得不可读.