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

时间:2016-01-05 10:08:01

标签: java comments sonarqube todo

我们有一个很大的应用程序,我们已经将TODO规则添加到质量门中,如果找到TODO注释则会出错。 如果我们只删除TODO评论(这是可怕的)它可以工作,但添加TODO评论的目的就会丢失。还有办法通过添加任何额外的东西来保持TODO评论,我们可以推迟TODO任务吗?(例如,这是一个巨大的任务)。

1 个答案:

答案 0 :(得分:2)

删除TODO,stop using them以查找非短期(票证或分叉的长度)的任何内容,并将其移至票证跟踪系统的票证中。

TODO评论有多个问题: -

  • 如果您使用的是无法自动定位它们的IDE,则很难找到它们。 (我知道Devs使用sublime甚至是Emacs所以需要进行特定的搜索)

  • 找工作是找不到的?

  • 如何追踪他们的时间?

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

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

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

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

enter image description here

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

enter image description here