"Public documented 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 我认为应该忽略getters和setter。有没有一些魔术可以说服声纳库贝不再警告这些？

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; }
}