Как игнорировать предупреждение Javadoc о контрольном стиле для метода с определенной аннотацией

Question

Как игнорировать предупреждение Javadoc о контрольном стиле для метода с определенной аннотацией

1

Checkstyle предупреждает, когда у меня есть открытый метод без javadoc, что приятно! Когда я переопределяю открытый метод, я не получаю предупреждение, потому что javadoc уже доступен в родительском классе для метода.

Теперь у меня есть другая аннотация для моего метода, например, @MyEvent. Теперь я получаю предупреждение, но не хочу этого, потому что аннотация говорит достаточно. Можно ли исключить предупреждения для методов с определенной аннотацией?

Есть некоторые решения, которые включают добавление материала в мой код, например, @SuppressWarnings или комментарии, такие как //CHECKSTYLE.OFF но это не делает мой код более //CHECKSTYLE.OFF этого я могу просто добавить javadoc. Поэтому я ищу решение для уровня конфигурации.

Martin 30 сен. 2014, в 13:48

Источник

Теги:

java

annotations

checkstyle

2 ответа

0

Свойство 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>

Naxos84 09 апр. 2018, в 08:35

Ещё вопросы

Thomas Jensen · Accepted Answer · 2014-09-30T18-21-00.000Z

Можно ли исключить предупреждения для методов с определенной аннотацией?

Вы можете подавлять предупреждения, используя одну конкретную аннотацию (@SuppressWarnings), но другие аннотации не могут использоваться для этого эффекта (например, @MyEvent).

По крайней мере, не из коробки. Если вы хотите сделать некоторые программы, вы можете разработать собственный собственный фильтр, который сделает все, что вам нужно.

Программирование это тогда. Я опубликую код здесь, если когда-нибудь решу это сделать :) спасибо!