Une doclet permet de préciser le format de la documentation générée. Le texte associé à un block tag suit le tag et se termine à la rencontre du tag suivant ou de la fin du commentaire. Ces tags commencent tous par le caractère arobase. N’essayez pas d’en faire trop, ce n’est pas le but. Un texte qui suit cet ensemble de tags est ignoré.
| Nom: | javadoc java |
| Format: | Fichier D’archive |
| Système d’exploitation: | Windows, Mac, Android, iOS |
| Licence: | Usage Personnel Seulement |
| Taille: | 13.45 MBytes |
Par défaut, elle contient toutes les classes c’est donc une liste très longue. Le tag deprecated permet de préciser qu’une entité ne devrait plus être utilisée même si elle fonctionne toujours: Certains IDEs créent un avertissement à la compilation si la méthode est appelée. La documentation produite est claire, simple, et complète. Le nom de la classe doit être de préférence pleinement qualifié. Le tag see permet de faire une référence à une autre méthode, classe, etc. Historique des versions de Javadoc.
Javadoc est un outil fourni par Sun avec le JDK pour permettre la génération d’une documentation technique à partir du code source.
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.
L’intérêt de ce système est de conserver dans le même fichier le code source et jaadoc éléments de la documentation qui lui sont associés. Il propose donc une auto-documentation des fichiers sources jvadoc façon standard. 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. L’outil Javadoc utilise plusieurs types de fichiers sources pour générer la documentation:.
En fonction des paramètres fournis à l’outil, ce dernier recherche les fichiers source. 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. Il peut contenir un texte libre et des balises particulières. Le commentaire peut être sur une ou plus généralement sur plusieurs lignes. Le commentaire doit commencer par une description de l’élément qui peut utiliser plusieurs lignes.
La première phrase de cette description est utilisée par javadoc comme résumé. Cette première phrase se termine javado un caractère ‘. Le texte du commentaire doit être au format HTML: A partir du JDK 1.
Le commentaire peut ensuite contenir des tags Javadoc particuliers qui commencent obligatoirement par le caractère et doivent être en début de ligne.
Ces tags doivent être regroupés ensemble. Un texte qui suit cet ensemble de tags est ignoré. Les tags prédéfinis par Javadoc permettent de fournir des informations plus précises sur des composants particuliers de l’élément auteur, paramètres, valeur de retour, Ces tags sont définis pour un ou plusieurs types d’éléments.
Les tags sont traités de façon particulière par Javadoc. Il existe deux types de tags:. Attention un caractère en début de ligne est interprété comme un tag. Le texte associé à un block tag suit le tag et se termine à la rencontre du tag suivant ou de la fin du commentaire. Ce texte peut donc s’étendre sur plusieurs lignes.
Les tags inline peuvent être utilisés n’importe où dans le commentaire de documentation.
Utilisation de javadoc
L’outil Javadoc traite de façon particulière les tags dédiés insérés dans le commentaire de documentation. Javadoc définit plusieurs tags qui permettent de préciser certains composants de l’élément décrit de façon standardisée.
Ces tags commencent tous javsdoc le caractère arobase. Pour pouvoir être interprétés, les tags standards doivent obligatoirement commencer en début de ligne. Le texte qui suit la balise est libre. Le doclet standard crée une section « Author » qui contient le texte du tag. Pour préciser plusieurs auteurs, il est possible d’utiliser un seul ou plusieurs tag author dans un même commentaire. Dans le premier cas, le contenu du texte est repris intégralement dans la section. Dans le second cas, la section contient le texte de chaque tag séparé par une virgule et un espace.
Le tag deprecated permet de préciser qu’une entité ne devrait plus être utilisée même si elle fonctionne toujours: Il est recommandé de préciser depuis quelle version l’élément est déprécié et de fournir dans le texte javaroc une description de la solution de remplacement, si elle existe, ainsi qu’un lien vers une entité de substitution. Le doclet standard crée une section « Deprecated » avec l’explication dans la documentation.
Ce tag est particulier car il est le seul reconnu par le compilateur: Javafoc de la compilation, l’utilisation d’entités marquées avec le tag deprecated générera un avertissement warning de la part du compilateur.
Ces tags permettent de documenter une exception levée par la méthode ou le constructeur décrit par le commentaire. Ils sont suivis du nom de l’exception puis d’une courte description des raisons de la levée de cette dernière. Il faut utiliser autant de tag exception ou throws qu’il y a d’exceptions. Ce tag doit être utilisé uniquement pour un élément de type méthode.
Il ne faut pas mettre de séparateur particulier comme un caractère ‘-‘ entre le nom et la description puisque l’outil en ajoute un automatiquement. Il est cependant possible d’aligner les descriptions de plusieurs paramètres en utilisant des espaces afin de faciliter la lecture.
Le doclet standard crée une section « Throws » qui regroupe les exceptions: Le tag param permet de documenter un paramètre d’une méthode ou d’un constructeur. Ce tag doit être utilisé uniquement pour un élément de type constructeur ou méthode. Ce tag est suivi du nom du paramètre ne pas utiliser le type puis d’une courte description de ce dernier. Il faut utiliser autant de tag param que de paramètres dans la signature de l’entité concernée.
La description peut être contenue sur plusieurs lignes. Le doclet standard crée une javva « Parameters » qui regroupe les tags param du commentaire. Il génère pour chaque tag une ligne dans cette section avec son nom et sa description dans la documentation.
Par convention les paramètres doivent être décrits dans leur ordre dans la signature de la méthode décrite. Le tag return jjavadoc de fournir une description de la valeur de retour d’une méthode qui en possède une. Il javzdoc peut y avoir qu’un seul tag return par commentaire: Avec le doclet standard, ce tag crée une section « Returns » jqvadoc contient le texte du tag.
La description peut tenir sur plusieurs lignes.
Créer de la javadoc
Il ne faut pas utiliser ce tag pour des méthodes ne possédant pas de valeur de retour void. Le tag see permet de définir un renvoi vers une autre entité incluse dans une documentation de type Javadoc ou vers une url. Class see class see champ see class champ see method Type,Type, Le tag génère un lien vers une entité ayant un lien avec celle documentée.
L’entité vers laquelle se fait le renvoi peut être un package, une classe, une méthode ou un javadox vers une page de la documentation.
Le nom de jsvadoc classe doit être de préférence javvadoc qualifié. Le caractère permet de séparer une classe d’un de ses membres champ, constructeur ou méthode. Pour javs une version surchargée particulière d’une méthode ou d’un constructeur, il suffit de préciser la liste des types d’arguments de la version concernée. Il est possible de fournir un libellé optionnel à la suite de l’entité.
Ce libellé sera utilisé comme libellé du lien généré: Si le tag est suivi d’un texte entre double cote, le texte est simplement repris avec les cotes sans lien. Le doclet standard crée une section « See Also » qui regroupe les tags see du commentaire en les séparant par une virgule et un espace. Iava see String equals see java.
Le tag since permet de préciser un numéro de version de la classe ou de l’interface à partir de laquelle l’élément décrit est disponible. Ce tag peut être utilisé avec tous les éléments. Le texte qui représente le numéro de version est libre. Le doclet standard crée une section « Since » qui contient le texte du tag. Par convention, pour limiter le nombre de sections Since dans la documentation, lorsqu’une nouvelle classe ou interface est ajoutée, il est préférable de mettre un tag since sur le commentaire de la classe et de ne pas le reporter sur chacun de ses membres.
Le tag since est utilisé sur un membre uniquement lors de l’ajout du membre. Le tag version permet de préciser un numéro de version.
Ce tag doit être utilisé uniquement pour un élément de type classe ou interface. Le texte qui suit la balise est libre: Le doclet standard crée une section « Version » qui contient le texte du tag. Jxva défaut, le doclet standard ne ajva pas en compte ce tag: Le mode de fonctionnement de ce tag est similaire au tag see: La référence utilisée avec ce tag suit la même forme que celle du tag see.
Javadoc — Wikipédia
Le javavoc du texte est repris intégralement sans interprétation. Ce tag permet de créer un lien vers un autre élément de la documentation dans une police normale. Ce tag est similaire au tag link. La différence réside dans la police d’affichage.
Ce tag permet de demander explicitement la recopie de la documentation de l’entité de la classe mère la plus proche correspondante. Ce tag représente le chemin relatif à la documentation générée.
Javadoc permet de fournir un moyen de documenter les packages car ceux-ci ne disposent pas de code source particulier: Ces fichiers navadoc être placés dans le répertoire désigné par le package. En plus, il est possible d’utiliser les tags deprecated, link, see et since.