Публичный документированный API не работает в Sonar?

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


sonarqube sonarqube-5.0
person egore911    schedule 26.01.2015    source источник

Ответы (2)


arrow_upward
2
arrow_downward

Единственный общедоступный элемент в вашем примере (класс SomeEntity) вообще не документирован, поэтому это может объяснить, почему показатель «Общедоступный документированный API» очень низкий.

person Fabrice - SonarSource Team    schedule 26.01.2015
comment
Но чтобы процитировать dev.eclipse.org/sonar/rules/show / Следующие общедоступные методы и конструкторы не учитываются этим правилом: геттеры и сеттеры, методы с аннотацией @Override, пустые конструкторы, статические константы. Даже с классовым комментарием это приводит к очень низкому показателю. Считаются ли в настоящее время геттеры/сеттеры общедоступным API? - person egore911; 27.01.2015

arrow_upward
0
arrow_downward

Не хватает одного комментария для класса

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