声纳中破坏了“公开记录的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我认为应该忽略吸气剂和制定剂。是否有一些神奇的技巧可以说服sonarqube不再警告这些？

Answer 1

您的示例中唯一公开的元素（SomeEntity类）根本没有记录，因此这可能解释了为什么您的＆＃34;公开记录的API＆＃34;措施非常低。

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