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

Question

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

我不同意公共(public)函数的每个参数都需要记录，也不同意返回值。 (通常文本说明了一切，对于 Spring MVC Controller 来说，参数是重复的且明显的等等。)但是，我确实同意每个公共(public)方法都需要记录下来。 (这个问题不是关于我在这里的观点是否明智。)

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

Answer 1

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