Check Comments/Javadoc количество слов с Checkstyle

Question

Возможно ли установить правило checkstyle, которое будет подсчитывать количество слов из commment, а затем показывает проблему, если количество слов находится под определенным лимитом. Я искал на checkstyle Javadoc свойствах, но не нашел что-то полезное.

Для примера:

/** 
* Stores the database connection. 
*/ 
private Connection mConnection; 

Комментарий содержит более 3 слов, и было бы правильно. Но если количество слов будет ограничено, checkstyle должен отметить это как проблему.

Если это возможно, было бы замечательно, если правило применяется к каждой части комментария (описание возврата, параметры, описание метода и т. Д.).

Answer 1

Для этого нет стандартной проверки Checkstyle. Однако вы можете написать свой собственный:

• Страница "Writing Checks" содержит введение.

• Вы можете использовать исходный код для классов в ...checks.javadocpackage, чтобы помочь вам разобраться, как бороться с комментариями.

---

Комментарий: количество слов не является допустимым показателем качества JavaDoc. Неплохой стиль имеет краткое или минимальное описание вещей, смысл которых вопиющий самоочевиден в контексте. Кроме того, подсчет слов только побуждает людей выставлять свои джавадоки бесполезными или бессмысленными вещами; например, «ядда, ядда, ядда» :-).

Если вы хотите сделать содержательную оценку качества javadoc, человеку нужно их прочитать.