遇到声纳错误时如何处理TODO注释

Question

我们有一个很大的应用程序，我们已将 TODO 规则添加到质量门中，如果找到 TODO 注释，则会出错。如果我们只是删除 TODO 注释（这很可怕），它会起作用，但添加 TODO 注释的全部目的就失去了。有没有办法通过添加任何额外的东西来保留 TODO 评论，我们可以推迟 TODO 任务？（例如，这是一个巨大的任务）。

Answer 1

删除 TODO，停止将它们用于非短期的任何事情（对于票或叉的长度），并将它们移到您的票跟踪系统上的票中。

TODO 评论有多个问题：-

• 如果您使用的是不自动定位它们的 IDE，则很难找到它们。（我知道使用 sublime 甚至 Emacs 的开发人员，因此需要进行特定搜索）

• 谁的工作是找到并修复这些问题？

• 如何跟踪花费在他们身上的时间？

• 它们可能会过时，就像大多数评论一样。如果有人在没有阅读 TODO 的情况下解决了问题并将其留在那里，则会引起混乱。如果另一个修复无意中修复了它，评论就会不知不觉地留在那里。

• 您现在有两个问题跟踪系统，一个是内部文档，另一个是您使用的任何问题跟踪系统。

• 如果您正在编写 TODO，那么您就是拥有修复它的知识的人。稍后有人将不得不根据没有描述的非常简短的评论来修复它。

没有什么比一个懒得做好的开发人员的一段代码更让人恼火的了，所以把它留给下一个人

或者一个不懒惰但太害怕破坏某些东西并且最终使问题变得更加复杂的人，而很少有评论表明存在问题