Как я могу проверить mvn checkstyle, если все содержимое моего комментария Javadoc начинается с заглавной буквы?

Question

Я бы хотел настроить свой контрольный стиль так, чтобы он проверял все мои комментарии javadoc, начинающиеся с заглавной буквы:

/** 
 * Hello

Где я могу это настроить? Я думаю, что сначала мне нужно включить checkstyle для комментариев, но я не уверен, как это сделать.

А как мне установить фильтр, который проверяет наличие \/\*\* и затем обеспечивает \s*\*\s[A-Z]+?

EDIT: Если То, что мне нужно, в настоящий момент не поддерживается checkstyle: как мне настроить свой собственный модуль checkstyle и включить его?

Answer 1

В настоящее время Checkstyle не поддерживает то, что вы хотите получить (насколько я знаю).Но процесс для этого должен быть следующим:

• Добавьте в свой Maven2 POM плагин checkstyle maven org.apache.maven.plugins:maven-checkstyle-plugin.
• Создайте конфигурацию checkstyle, включающую нужные вам правилаиметь.
• Ссылка на эту конфигурацию в вашем POM как configLocation.

Checkstyle поддерживает как правила для классов и стилей:

• Проверить пустой JavaDoc
• Проверить первое предложение (чтобы оно существовало)
• Проверить конец предложения (но не начало)

Что вы можете сделать (в долгосрочной перспективе), чтобыразверните checkstyle и добавьте свой вклад в сообщество, чтобы он мог быть интегрирован в сам Checkstyle и плагин Maven для Checkstyle.Взгляните на «Расширяющий Checkstyle» , это не так сложно, я сделал это самостоятельно.Для примера смотрите реализацию Checkstyle JavaDoc Style .Сложность состоит в том, чтобы поместить это в проект и доставить его везде, где оно понадобится: Maven, Eclipse, NetBeans, Sonar, ...