声纳类TODO警告

Question

在我的代码中，我有不同类型的TODO项目：

• 有些人的意思是“这完全是必须要做的”。
• 其他人则更喜欢“如果你觉得无聊，为什么不加这个呢？”

这方面的一个例子是在我的IntelliJ插件中：VirtualFileSystem中有一个VirtualFileSystem方法，它对用户有一定的友好性，可以最终实现，但是没有它，一切都很好，所以它更像是一个// NICETOHAVE:，而不是一个// TODO:。

我喜欢在代码中添加这样的注释，但是由于我使用Sonar来检查我的代码库，这会产生一些令人讨厌的检查警告，而IntelliJ在VCS中推送我的代码时一直困扰着我。

所以我的问题是，在我的代码中是否有其他方式可以对代码进行注释，以便最终实现它，但如果您在进行高亮显示的同时真正做到这一点并不重要吗？

Answer 1

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

如果您想跟踪其他注释，您可能会更喜欢编写自定义规则 (因为没有向这些规则添加自定义的计划)，通过查看java插件的源代码：FixMeTagPresenceCheck和CommentContainsPatternChecker，您可以获得如何做到这一点的灵感。