Список всіх класів БЕЗ Javadocs - java, javadoc

Чи є простий спосіб аналізувати вихідний код, щоб перерахувати кількість класів, які не мають жодного javadocs?

Як частина технічної заборгованості, я хотів би перерахувати всі ці файли і поділитися списком серед команди, щоб їхні автори писали їх.

Примітка: ми використовуємо gradle як систему побудови

UPDATE ... Так порожні javadocs створюються за замовчуванням, але наші devs havnt заповнили їх багато. Я хотів би бачити всі класи, які не мають жодного опису в документі на рівні класу. Я не пам'ятаю про методи занадто багато.

Відповіді:

Простим способом було б використовувати Чецетілл.

Завантажте файл jar і створіть XML-файл конфігурації (javadoc_checks.xml) так:

<module name="Checker">
<module name="TreeWalker">
<module name="JavadocType"/>
<module name="JavadocMethod"/>
<module name="JavadocVariable"/>
<module name="JavadocStyle"/>
</module>
</module>

Тепер виконайте наступну команду (якщо все знаходиться в тому ж каталозі і src містить ваш код):

java -jar checkstyle-6.9-all.jar -c javadoc_checks.xml src/

Якщо, наприклад, ви просто хочете перевірити відсутність javadocs для класів і інтерфейсів, то вам просто потрібно це в конфігурації XML:

<module name="Checker">
<module name="TreeWalker">
<module name="JavadocType"/>
</module>
</module>

А вихід буде щось подібне:

C:srccomexampleTest.java:137: Javadoc comment missing.
C:srccomexampleTest1.java:3: Javadoc comment missing.
C:srccomexampleTest2.java:12: Javadoc comment missing.

Є багато варіантів, які можна переглянути в:

http://checkstyle.sourceforge.net/config_javadoc.html

http://checkstyle.sourceforge.net/cmdline.html