java - 未记录的 API Sonar 规则在 sonarqube 6.5 中不起作用？

Question

规则“公共(public)类型、方法和字段 (API) 应使用 Javadoc 进行记录”似乎在 SonarQube 6.5 中不起作用。

我激活了 Java 质量配置文件中的规则，将该配置文件设置为默认值，并通过 mvn sonar:sonar 命令运行我的 Java 代码库。

尽管某些方法缺少 Javadoc，但它没有发现任何违反此规则的情况。其他规则可以很好地发现违规行为。

我的测试类是这样的:

package counter;

/**
 * This is a Javadoc comment
 */
public class MyClass {    

 public static final int DEFAULT_STATUS = 0;    // Compliant - static constant
 private int status;                           // Compliant - not public

 public String message;                  // Noncompliant

 public MyClass() {                         // Noncompliant - missing documentation
   this.status = DEFAULT_STATUS;
 }

 public void setStatus(int status) {  // Compliant - setter
   this.status = status;
 }

 protected int doSomething() {
     return status + 24;// Compliant - not public
 }

 public int doSomething2(int value) {  // Noncompliant
     int a = value*8;
     return a*1;
 }

 public int doSomething3(int value) {  // Noncompliant
   return value*9;
 }
}

Answer 1

这似乎是一个issue在 SonarQube 6.5 中。您可以做的是升级到 SonarQube 6.7.7，更新所有插件，检查所使用的配置文件中规则的激活情况，然后重试。请注意，最新的 LTS 版本是 7.9，因此您应该准备从 6.7.x 升级到下一个主要版本 7.9。还要再次更新插件。