在我的代码中,我有不同类型的 TODO 项:
- 有些意思是“这完全需要完成”
- 其他人更像是“如果你感到无聊,为什么不添加这个?”
我的 IntelliJ 插件中有一个例子:有一个 refresh
VirtualFileSystem
中的方法最终实现起来会有点用户友好,但即使没有它,一切也能正常工作,所以它更像是一个 // NICETOHAVE:
而不是 // TODO:
.
我喜欢在代码中添加这样的注释,但由于我使用 Sonar 检查我的代码库,这会产生一些令人讨厌的检查警告,并且在将我的代码推送到 VCS 中时,IntelliJ 一直困扰着我。
所以我的问题是,有没有其他方法可以在我的代码中注释某些东西,这些东西最终可能会很好地实现,但如果您真正做到这一点,同时仍然有一些很好的突出显示,这并不重要?
最佳答案
只有两个规则跟踪评论:TODO 和 FIXME
如果您想跟踪其他评论,您最好使用 writing your custom rule (因为没有计划向这些规则添加自定义)并且您可以通过查看 java 插件的源代码获得如何执行此操作的灵感:FixMeTagPresenceCheck和 CommentContainsPatternChecker
关于java - TODO 警告的 Sonar 类别,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/40980607/