Правило «Открытые типы, методы и поля (API) должны быть задокументированы с помощью Javadoc», похоже, не работает в SonarQube 6.5.
Я активировал правило в профиле качества Java, установил профиль по умолчанию и запустил свою кодовую базу Java с помощью команды mvn sonar:sonar
.
Никаких нарушений этого правила он не обнаружил, хотя в некоторых методах отсутствует Javadoc. Другие правила отлично работают при обнаружении нарушений.
Мой тестовый класс выглядит примерно так:
package counter;
/**
* This is a Javadoc comment
*/
public class MyClass {
public static final int DEFAULT_STATUS = 0; // Compliant - static constant
private int status; // Compliant - not public
public String message; // Noncompliant
public MyClass() { // Noncompliant - missing documentation
this.status = DEFAULT_STATUS;
}
public void setStatus(int status) { // Compliant - setter
this.status = status;
}
protected int doSomething() {
return status + 24;// Compliant - not public
}
public int doSomething2(int value) { // Noncompliant
int a = value*8;
return a*1;
}
public int doSomething3(int value) { // Noncompliant
return value*9;
}
}