sonarqube - 声纳中的“公开记录的 API”被破坏了吗？

Question

我正在使用 Java 2.8 插件运行 Sonar 5.0。它为公共记录的 API 生成一个百分比值，该值非常低。

这是由于记录了如下的实体类被标记为 0%：

public class SomeEntity {
  /** Some Javadoc */
  private String someField;
  public String getSomeField() { return someField; }
  public void setSomeField(String someField) { this.someField = someField; }
}

基于https://dev.eclipse.org/sonar/rules/show/squid:UndocumentedApi?layout=false我认为应该忽略 getter 和 setter。是否有一些魔术可以说服 sonarqube 不再警告这些？

Answer 1

您的示例（类）中唯一公开的元素SomeEntity根本没有记录，因此这可以解释为什么您的“公开记录的 API”度量非常低。

Answer 2

该课程缺少一条评论

/** COMMENT YOUR CLASS **/    
public class SomeEntity {
  /** Some Javadoc */
  private String someField;
  public String getSomeField() { return someField; }
  public void setSomeField(String someField) { this.someField = someField; }
}