Настройка Checkstyle для игнорирования общих предупреждений

Я работаю над проектом и использую checkstyle для проверки javadocs для проекта. Я не хочу никаких предупреждений javadoc checkstyle.

Однако checkstyle дает мне следующее нежелательное предупреждение о дженериках:

Ожидаемый тег @param для '‹ T > '.

Есть ли способ отключить или подавить это конкретное предупреждение?

Единственный способ, с которым я столкнулся, - это подавление предупреждений для определенной строки, которую я не хочу делать.

Кто-нибудь знает способ настройки стиля проверки для игнорирования общих предупреждений?


java generics javadoc suppress-warnings checkstyle
person Kevin    schedule 24.06.2013    source источник

Ответы (1)


arrow_upward
1
arrow_downward

Вы можете настроить это поведение проверки JavadocType, задав для свойства allowMissingParamTags значение true следующим образом:

<module name="JavadocType">
    <property name="allowMissingParamTags" value="true"/>
</module>

В моей версии плагина Eclipse checkstyle (5.6.0.201209221626) этот параметр почему-то отсутствует в графическом интерфейсе (ошибка?), но его можно установить, непосредственно отредактировав XML.

person barfuin    schedule 25.06.2013
comment
Спасибо за ответ. Оказывается, мне не нужно было этого делать, так как я хотел все-таки увидеть ошибки. Но просто из любопытства, если я сделаю так, как вы предлагаете, не отключит ли это предупреждения для всех отсутствующих тегов Javadoc? Я бы все равно хотел увидеть все остальные отсутствующие теги param. Только не универсальные. Вы понимаете, откуда я? Возможно, это невозможно? - person Kevin; 26.06.2013
comment
@Kevin Да, это повлияет только на ваши общие параметры типа, потому что он установлен при проверке JavadocType, которая не знает других параметров. JavadocMethod не затрагивается (что может быть проблемой, если у вас есть методы с общими параметрами). - person barfuin; 26.06.2013