java - Sonarqube 的 UndocumentedApi 变得毫无用处？

Question

我最近在我们的 SonarQube 安装中更新了 Java pugin。我现在报告了很多很多 UndocumentedApi 实例。

我不同意公共函数的每个参数都需要记录，也不需要返回值。（通常文本说明了一切，对于 Spring MVC 控制器，论点是重复的并且非常明显等。）但是，我同意每个公共方法都需要记录。（这个问题不是关于我在这里的意见是否明智。）

我只看到选项要么接受 > 1000 个隐藏更重要问题的警告，要么禁用该检查，从而丢失此分析。我是否忽略了一个选项？有没有更可配置的插件？

Answer 1

您应该使用关闭违规插件来调整您的分析并消除噪音。据我了解，您可以在 Spring 类上停用此 UndocumentedApi 规则，因为它在这种情况下不相关。请参阅http://docs.codehaus.org/display/SONAR/Switch+Off+Violations+Plugin。