2016-11-29 22 views
1

У меня есть файл Java, который имеет 40 строк комментариев в начале исходного кода для описания основного алгоритма, реализованный в нем, как это:Java PMD CommentSize ошибки в заголовок комментарии

/** 
* Detailed descriptions 
* ... 
    ... < total 40 lines of comments > ... 
*/ 

Однако PMD испускает ошибка "CommentSize", как это:

<violation beginline="1" endline="40" begincolumn="1" endcolumn="2" 
rule="CommentSize" ruleset="Comments" 
package="..." 
externalInfoUrl="https://pmd.github.io/pmd-5.4.0/pmd-java/rules/java/comments.html#CommentSize" 
priority="3"> 
    Comment is too large: Too many lines 
</violation> 

С подробной explanation here я нашел:

установ не имеет ли размеры не-заголовок Найдено в указанных пределах.

В моем понимании это правило в своей работе применяет только без заголовка комментарии и мои комментарии в верхней части исходного кода не должно вызывать эту ошибку, так что мой вопрос: должен ли я неправильно понять, что без заголовка комментарии или есть проблема реализации в PMD?

+0

Это похоже на ошибку в PMD. Вероятно, вы должны сообщить об этом по адресу https://github.com/pmd/pmd/issues. – Johnco

ответ

0

Вы настроили правило? Существует parameter с именем headerCommentRequirement, который вы можете настроить. Я думаю, вам нужно будет игнорировать его.