«Открытый документированный API», сломанный в Sonar?

Question

Я запускаю Sonar 5.0 с плагином Java 2.8. Он генерирует процентное значение для общедоступного документального 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 я бы утверждать, что методы получения и установки должны быть проигнорированы. Есть ли какой-то волшебный трюк, чтобы убедить сонарква больше не предупреждать об этом?

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