Checkstyle предупреждает, когда у меня есть открытый метод без javadoc, что приятно! Когда я переопределяю открытый метод, я не получаю предупреждение, потому что javadoc уже доступен в родительском классе для метода.
Теперь у меня есть другая аннотация для моего метода, например, @MyEvent
. Теперь я получаю предупреждение, но не хочу этого, потому что аннотация говорит достаточно. Можно ли исключить предупреждения для методов с определенной аннотацией?
Есть некоторые решения, которые включают добавление материала в мой код, например, @SuppressWarnings
или комментарии, такие как //CHECKSTYLE.OFF
но это не делает мой код более //CHECKSTYLE.OFF
этого я могу просто добавить javadoc. Поэтому я ищу решение для уровня конфигурации.
Можно ли исключить предупреждения для методов с определенной аннотацией?
Вы можете подавлять предупреждения, используя одну конкретную аннотацию (@SuppressWarnings
), но другие аннотации не могут использоваться для этого эффекта (например, @MyEvent
).
По крайней мере, не из коробки. Если вы хотите сделать некоторые программы, вы можете разработать собственный собственный фильтр, который сделает все, что вам нужно.
Свойство allowedAnnotations модуля JavadocMethod определяет, какие аннотированные методы пропускаются/игнорируются для проверки javadoc. В данном примере используется Checkstyle v8.8.
<module name="Checker">
<module name="TreeWalker">
<module name="JavadocMethod">
<property name="allowedAnnotations" value="Override, Test, Before, BeforeClass"/>
</module>
</module>
</module>