comments - 注释被删除的代码

Question

关闭。这个问题是 opinion-based 。目前不接受答案。

已关闭 6 年前。

已锁定。这个问题及其答案是 locked因为这个问题是题外话，但却具有历史意义。目前不接受新的答案或互动。

对已删除的代码进行注释是一个好习惯吗？例如:

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

我的开发人员小组中的某人在同行评审期间指出，我们应该注释要删除的代码行。我认为这是一个糟糕的建议，因为它用无用的注释使代码变得困惑。我们谁是对的？

Answer 1

通常，不应对被删除的代码进行注释，因为它会使代码库变得困惑(而且，为什么要对不存在的东西进行注释？)。

您的缺陷跟踪系统或源代码控制管理工具就是此类评论所属的地方。