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

Question

我们有一个大型应用程序，并且我们已将

TODO

规则添加到 SonarQube 质量门，当发现

TODO

评论时，该规则会引发错误。

这会鼓励开发人员删除

TODO

评论，这很可怕，因为添加

TODO

评论的整个目的就消失了。

有没有办法通过添加某种覆盖或忽略注释

类似于ESLint

来保留TODO注释？我们希望推迟处理

TODO

，但仍然会收到开发人员留下的

TODO

任务的通知，当这些任务不符合当前工单的范围时，不会阻塞构建。

Answer 1

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

TODO 评论有多个问题：-

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

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

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

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

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

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

没有什么比开发人员懒得把工作做好而把它留给下一个人更令人恼火的了

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