【问题标题】:Sonar category of TODO warningsTODO 警告的声纳类别
【发布时间】:2018-05-15 13:44:25
【问题描述】:

在我的代码中,我有不同类型的 TODO 项:

  • 有些意思是“这完全需要做”
  • 其他的更像是“如果你觉得无聊,为什么不添加这个?”

我的 IntelliJ-Plugin 中就是一个例子:VirtualFileSystem 中有一个 refresh 方法,最终实现对用户来说有点友好,但即使没有它,一切都可以正常工作,所以它是更像是 // NICETOHAVE: 而不是 // TODO:

我喜欢将这样的 cmets 添加到代码中,但由于我使用 Sonar 检查我的代码库,这会产生一些令人讨厌的检查警告,并且在 VCS 中推送我的代码时 IntelliJ 一直在困扰我。

所以我的问题是,是否有其他方法可以在我的代码中注释某些内容,最终可能会很好地实现,但如果你真正做到这一点,同时仍然有一些很好的突出显示,这并不重要?

【问题讨论】:

    标签: java intellij-idea sonarqube


    【解决方案1】:

    跟踪 cmets 的规则只有两个:TODO 和 FIXME

    如果您想跟踪其他 cmets,您可能会更好 writing your custom rule(因为没有计划为这些规则添加自定义),您可以通过查看 java 的源代码来获得如何做到这一点的灵感插件:FixMeTagPresenceCheckCommentContainsPatternChecker

    【讨论】:

      猜你喜欢
      • 2020-06-10
      • 1970-01-01
      • 2015-03-25
      • 1970-01-01
      • 2016-03-06
      • 2022-01-14
      • 1970-01-01
      • 1970-01-01
      • 2015-03-21
      相关资源
      最近更新 更多