代码之家 › 专栏 › 技术社区 › Metalhead

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

todo sonarqube comments java

4

Metalhead · 技术社区 · 9 年前

我们有一个很大的应用程序,我们已经将TODO规则添加到质量门中,如果发现TODO注释,就会出现错误。如果我们只是删除TODO注释(这很可怕),它会起作用,但添加TODO评论的全部目的就失去了。是否还有一种方法可以通过添加任何额外内容来保留TODO注释,从而推迟TODO任务?(例如,这是一项巨大的任务)。

1 回复 | 直到 9 年前

1

7

Ross Drew 9 年前

移除TODO, stop using them 对于任何不是短期的东西(对于车票或叉车的长度),并将它们移动到您的车票跟踪系统上的车票中。

TODO注释有多个问题:-

如果您使用的IDE不能自动定位它们,则很难找到它们。(我知道开发人员使用submite甚至Emacs,因此需要进行特定搜索)
谁的工作是找到并修复这些?
如何跟踪花在他们身上的时间?
它们可能会过时,就像大多数评论一样。如果有人在没有阅读TODO的情况下修复了问题,并将其留在那里,这会导致混乱。如果另一个修复程序无意中修复了它,注释会不知不觉地留在那里。
现在您有两个问题跟踪系统,一个是内部文档,一个在您使用的任何问题跟踪系统中。
如果你在写TODO,那么你就是有知识来解决它的人。稍后有人将不得不根据一个非常简短的评论(没有描述)来修复它。

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

或者一个并不懒惰,但害怕打破东西的人,最后只会让问题变得更复杂,只需很少的评论就表明有问题