Mesure de la couverture de la documentation avec Javadoc et Ant

Question

Je participe à un projet dans lequel la documentation de l'API publique est clairement livrable. Afin de s'assurer que la version répond à cette exigence, je voudrais m'assurer que la cible de publication dans mon fichier de construction Ant échoue si la couverture de la documentation est trop faible. Au minimum, chaque identificateur avec un accès public ou protégé doit avoir des balises Javadoc appropriées et une description. Par exemple, les méthodes publiques doivent avoir une balise @param pour chaque paramètre, une balise @return si le type de retour n'est pas void, une balise @throws pour chaque exception et une description de ligne unique. J'ai actuellement des rapports de couverture de code JUnit et des conditions d'échec utilisant Cobertura, donc quelque chose de similaire à celui de la documentation serait parfait. Cependant, si la détection d'une condition de défaillance n'est pas disponible, un rapport peut être un substitut raisonnable. La documentation doit être au format Javadoc. Aucun autre format - y compris Doxygen - n'est acceptable.

Answer 1

Checkstyle peut le faire.

Answer 2

Je ne connais pas un tel outil, mais je pense que Doxygen peut générer des fichiers XML qui décrivent la structure du code avec les commentaires. Vous pouvez écrire un script qui effectuera des tests simples et trouver des méthodes non documentées/params/return values ​​/ etc.