java - 遇到 Sonar 错误时如何处理TODO注释

Question

我们有一个很大的应用程序，我们已经将 TODO 规则添加到质量门中，如果发现 TODO 注释，它会给出错误。如果我们只是删除 TODO 注释(这很可怕)，它会起作用，但添加 TODO 注释的整个目的就会丢失。是否仍然有办法通过添加任何额外的东西来保留 TODO 评论，我们可以通过这种方式推迟 TODO 任务？(例如，这是一项巨大的任务)。

Answer 1

删除 TODO，stop using them对于任何不是短期的(对于票证或 fork 的长度)，并将它们移动到您的票证跟踪系统的票证中。

TODO 注释有多个问题:-

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

• 找到并解决这些问题是谁的工作？

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

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

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

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

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

或者一个不懒惰但不敢破坏某些东西的人，结果只是用最少的评论让问题变得更复杂