Cours developpement Java SE7 et JavaDoc en pdf | Cours informatique | Cours gratuit
Javadoc est un outil fourni par Sun avec le JDK pour permettre la génération d'une documentation technique à partir du code source. Cours developpement Java SE7 et JavaDoc en pdf | Cours informatique | Cours gratuit
Cet outil génère une documentation au format HTML à partir du code source Java et des commentaires particuliers qu'il contient. Un exemple concret de l'utilisation de cet outil est la documentation du JDK qui est générée grâce à Javadoc.
Cette documentation contient :
une description détaillée pour chaque classe et ses membres public et protected par défaut (sauf les classes internes anonymes) un ensemble de listes (liste des classes, hiérarchie des classes, liste des éléments deprecated et un index général) des références croisées et une navigation entre ces différents éléments. Cours developpement Java SE7 et JavaDoc en pdf | Cours informatique | Cours gratuit
L'intérêt de ce système est de conserver dans le même fichier le code source et les éléments de la documentation qui lui sont associés. Il propose donc une auto-documentation des fichiers sources de façon standard.
Ce chapitre contient plusieurs sections :
La mise en oeuvre Les tags définis par javadoc
Un exemple
Les fichiers pour enrichir la documentation des packages La documentation générée Javadoc s'appuie sur le code source et sur un type de commentaires particuliers pour obtenir des données supplémentaires des éléments qui composent
le code source. Cours developpement Java SE7 et JavaDoc en pdf | Cours informatique | Cours gratuit
L'outil Javadoc utilise plusieurs types de fichiers sources pour générer la documentation :
Les fichiers sources .java
Les fichiers de commentaires d'ensemble
Les fichiers de commentaires des packages
D'autres fichiers tels que des images, des fichiers HTML, ... Cours developpement Java SE7 et JavaDoc en pdf | Cours informatique | Cours gratuit
En fonction des paramètres fournis à l'outil, ce dernier recherche les fichiers source .java concernés. Les sources de ces fichiers sont scannées pour déterminer leurs membres, extraire les informations utiles et établir un ensemble de références croisées.
Le résultat de cette recherche peut être enrichi avec des commentaires dédiés insérés dans le code avant chaque élément qu'ils enrichissent. Ces commentaires doivent immédiatement précéder l'entité qu'ils concernent (classe, interface, méthode, constructeur ou champ). Seul le commentaire qui précède l'entité est traité lors de la génération de la documentation.
Ces commentaires suivent des règles précises. Le format de ces commentaires commence par /** et se termine par */. Il peut contenir un texte libre et des balises particulières. Cours developpement Java SE7 et JavaDoc en pdf | Cours informatique | Cours gratuit
Le commentaire peut être sur une ou plus généralement sur plusieurs lignes. Les caractères d'espacement (espace et tabulation) qui précèdent le premier caractère * de chaque ligne du commentaire ainsi que le caractère lui-même sont ignorés lors de la génération. Ceci permet d'utiliser le caractère * pour aligner le contenu du commentaire. Cours developpement Java SE7 et JavaDoc en pdf | Cours informatique | Cours gratuit