Javadoc est un outil fourni dans le JDK qui analyse les déclarations et commentaires de documentation dans un jeu de fichiers source Java et produit le jeu correspondant de pages HTML décrivant les objets du modèle.
Les commentaires Javadoc sont inclus dans le code source d'un objet, immédiatement avant la déclaration d'un objet, entre /** et */.
Un commentaire Javadoc peut contenir :
Par exemple, dans l'onglet d'aperçu de code suivant, vous pouvez lire la balise @author, et le commentaire inséré depuis la zone Commentaire de l'onglet Général de la feuille de propriétés de classe.
Le tableau suivant résume la prise en charge des commentaires Javadoc dans PowerAMC :
|
Javadoc |
Description |
S'applique à |
Attribut étendu correspondant |
|---|---|---|---|
|
%comment% |
Zone de commentaire. Si les commentaires Javadoc sont introuvables, les commentaires standard sont récupérés à la place. |
Classe, interface, opération, attribut |
— |
|
@since |
Ajoute un en-tête "Since" avec le texte since spécifié dans la documentation générée. |
Classe, interface, opération, attribut |
Javadoc@since |
|
@deprecated |
Ajoute un commentaire indiquant que cette API n'est plus utilisable. |
Classe, interface, opération, attribut |
Javadoc@deprecated |
|
@author |
Ajoute une entrée Author. |
Classe, interface |
Javadoc@author. Si la balise n'est pas définie, le nom d'utilisateur de l'onglet Version est utilisé. Dans le cas contraire, la valeur définie pour la balise est affichée. |
|
@version |
Ajoute une entrée Version, faisant le plus souvent référence à la version du logiciel. |
Classe, interface |
Javadoc@version |
|
@see |
Ajoute un en-tête "See Also" avec un lien ou une entrée de texte qui pointe vers une référence. |
Classe, interface, opération, attribut |
Javadoc@see |
|
@return |
Ajoute une section "Returns" avec le texte descriptif. |
Opération |
Javadoc@misc |
|
@throws |
Ajoute une sous-section "Throws" à la documentation générée. |
Opération |
Javadoc@misc. Vous pouvez déclarer des exceptions d'opération. |
|
@exception |
Ajoute une sous-section "Exception" à la documentation générée. |
Opération |
Javadoc@misc. Vous pouvez déclarer des exceptions d'opération. |
|
@serialData |
Documente les types et l'ordre des données dans le formulaire sérialisé. |
Opération |
Javadoc@misc |
|
@serialField |
Documente un objet ObjectStreamField d'un membre serialPersistentFields d'une classe sérialisable. |
Attribut |
Javadoc@misc |
|
@serial |
Utilisé dans le commentaire pour un champ sérialisable par défaut. |
Attribut |
Javadoc@misc |
|
@param |
Ajoute un paramètre à la section Paramètres. |
Opération |
Javadoc@misc |