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

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

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

Прогнозный @param тег для «< Т>».

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

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

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

источник

2013-06-24 Kevin

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

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

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

источник

2013-06-25 20:37:54

Спасибо за ответ. Оказывается, мне не нужно было это делать, поскольку я хотел увидеть ошибки в конце концов. Но только из любопытства, если бы я сделал это, как вы предлагаете, это не отключит предупреждения для всех отсутствующих тегов Javadoc? Я бы все же хотел увидеть все другие теги отсутствующих параметров. Просто не общие. Вы понимаете, откуда я? Возможно, это невозможно? – Kevin

@Kevin Да, это повлияет только на параметры вашего общего типа, потому что он установлен в * JavadocType * check, который не знает других параметров. * JavadocMethod * не затрагивается (что может быть «проблемой», если у вас есть методы с общими параметрами). –

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

ответ

Смежные вопросы