2015-04-27 3 views
3

В проекте, над которым я работаю, checkstyle терпит неудачу с «Отсутствует комментарий Javadoc» из-за отсутствия комментария Javadoc на частной переменной. Это кажется излишне строгим поведением для меня, и я хотел бы подавить ошибку для частных членов, используя XML-файл подавления.Запретить ошибки проверки в PRIVATE переменных-членах в файле suppressions.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, чтобы дать мне ограниченное подавление, в котором я нуждаюсь?

ответ

1

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

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

scope из package означает «package или более публичным».

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

  • Нет связанных вопросов^_^