Как мне заставить checkstyle не работать, если между javadoc и @param нет пустой строки - PullRequest
0 голосов
/ 02 ноября 2018

Например, у меня есть код ниже. Я хочу, чтобы checkstyle жаловался, потому что между моим комментарием javadoc и моими @ пунктами нет пустой строки.

/**
 * This line or the next line should fail checkstyle.
 * @param param is essential
 * @throws Exception is thrown when something bad happens
 */

Checkstyle не должен жаловаться, когда javadoc изменен так:

/**
 * This line or the next line should no longer fail.
 * 
 * @param param is essential
 * @throws Exception is thrown when something bad happens
 */

Я попытался использовать предложение @Mureinik, и оно не жаловалось на отсутствие пустой строки между первым абзацем и @ -пунктами. Я подтвердил, что Eclipse распознал, что я включил JavadocParagraph на скриншоте ниже.

<module name="JavadocParagraph"/>

enter image description here

1 Ответ

0 голосов
/ 02 ноября 2018

Проверка JavadocParagraph должна обеспечить это. Просто добавьте следующее в вашу конфигурацию checkstyle:

<module name="JavadocParagraph"/>
...