Medición de la cobertura de documentación con Javadoc y Ant

Question

Estoy involucrado en un proyecto en el que la documentación API pública es un producto claro. Para garantizar que la versión cumpla con este requisito, me gustaría asegurarme de que el objetivo de publicación en mi archivo de compilación Ant falle si la cobertura de la documentación es demasiado baja.

Como mínimo, cada identificador con acceso público o protegido debe tener etiquetas Javadoc adecuadas y una descripción. Por ejemplo, los métodos públicos deben tener una etiqueta @param para cada parámetro, una etiqueta @return si el tipo de devolución no es void, una etiqueta @throws para cada excepción y una descripción de línea única.

Actualmente tengo informes de cobertura de código JUnit y condiciones de falla usando Cobertura, por lo que algo similar a la documentación sería perfecto. Sin embargo, si la detección de una condición de falla no está disponible, un informe puede ser un sustituto razonable.

La documentación debe estar en formato Javadoc. Ningún otro formato, incluido Doxygen, es aceptable.

Answer 1

Checkstyle puede hacer eso.

Answer 2

No conozco esta herramienta, pero creo que Doxygen puede generar archivos XML que describan la estructura del código junto con los comentarios. Puede escribir un script que le haga algunas pruebas sencillas y encuentre métodos/params/valores de retorno/etc. No documentados.