Подавить ошибки стиля проверки для переменных-членов PRIVATE в файле подавления.xml?

В проекте, над которым я работаю, checkstyle не работает с сообщением «Отсутствует комментарий Javadoc» из-за отсутствия комментария Javadoc в переменной-члене private. Это кажется мне излишне строгим поведением, и я хотел бы подавить ошибку для частных членов, используя XML-файл подавления.

В следующем файле удается подавить все ошибки Checkstyle Javadoc для переменных:

<?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC
    "-//Puppy Crawl//DTD Suppressions 1.1//EN"
    "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">

<suppressions>
    <suppress files=".*" checks="JavadocVariable"/>
</suppressions>

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

Как я могу изменить атрибут checks, чтобы дать мне необходимое ограниченное подавление?


java javadoc checkstyle code-standards
person 0xbe5077ed    schedule 27.04.2015    source источник

Ответы (1)


arrow_upward
2
arrow_downward

Afaik, этого нельзя добиться с помощью подавления, если только вы не хотите аннотировать каждое приватное поле. Вместо этого настройте проверку JavadocVariable, чтобы она не охватывала частную область:

<module name="JavadocVariable">
   <property name="scope" value="package"/>
</module>

область package означает "package или более общедоступную".

person barfuin    schedule 27.04.2015