31/12/2009
Didier Donsez, Outils de développement Java, 1997-2009
4
Documentation
Javadoc (JDK)
Génération automatique de la documentation HTML
à partir des commentaires présents dans les .java
Commentaires et Tags
/**
* This is a <b>doc</b> comment.
* @see java.lang.Object
* @todo fix {@underline this !}
*/
Documentation Standard (HTML avec/sans frame)
hiérarchie des classes et des interfaces, liste des packages
résumé et détail d ’une classe, interface, méthode, propriété,…
Documentation Customisée (RTF, XML, MIF, HTML, …)
Doclet : classe Java chargée par Javadoc
pour personnaliser le résultat de la génération de la documentation
Taglet : classe Java personnalisant la sortie HTML lié à un tag (bloc ou inline)
Remarque
N ’oubliez pas d’ajouter la génération au Makefile/Build/POM file
Tags non
standards