Как отключить проверку подлинности JavaDoc checkstyle для конструкторов?

Question

Как отключить проверку JavaDoc проверки подлинности для конструкторов?

Я вижу, что http://checkstyle.sourceforge.net/config_javadoc.html#JavadocMethod четко заявляет, что он «проверяет Javadoc метода или конструктора», однако мне нужно исключить конструкторы и оставить только методы.

Answer 1

Для того, чтобы игнорировать конструктор, удалить CTOR_DEF маркер из tokens собственности, например:

<module name="JavadocMethod"> 
    <property name="tokens" value="METHOD_DEF,ANNOTATION_FIELD_DEF"/> 
</module> 

Это достигается путем установки tokens ко всем другим, кроме разрешенных маркеров CTOR_DEF. К сожалению, для этого вам нужно знать, какие маркеры установить, и этот список зависит от версии Checkstyle и не всегда точно отражается в docs. Этот вышеприведенный пример должен обеспечить разумную настройку.

Answer 2

Игнорировать Javadocs только на конструкторах с пользовательским классом ...

<module name="org.example.MyJavadocMethodCheck"> 
... 
</module> 

, который выглядит следующим образом:

@SuppressWarnings("unused") 
public class MyJavadocMethodCheck extends com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck { 

    @Override 
    public int[] getAcceptableTokens() { 
     return Arrays.stream(super.getAcceptableTokens()) 
      .filter(t -> t != TokenTypes.CTOR_DEF) // Don't enforce javadoc comments on constructors 
      .toArray(); 
    } 
} 

Я уверен, что я нашел это на StackOverflow, но не могу найти точная ссылка больше.