ASDoc - Liste des balises @tag
| @copy | Copie le commentaire ASDoc depuis une autre classe ou interface. La description principale, les ballises @param et @return sont copiées, les autres balises ne sont pas copiées.
On l’utilise pour copier une description depuis une classe ou une interface qui n’est pas dans la liste d’héritage. Vous pouvez placer des commenatires ASDoc avant la balise @copy. Spécifiez la source avec la même syntaxe que celle de la balise @see. /** * @copy #methode * @copy MovieClip#stop * @copy package.class#property */ |
| @default | Spécifie la valeur par défaut d’une propriété. |
| @example | Ajoute l’exemple de code qui suit cette balise dans l’élément concerné.
Insérez votre code entre ces balises<listing version=”3.0″></listing>. Le formatage du code sera préservé et il sera affiché dans une box grise avec scrolling si necessaire. /** * @example Le code suivant regle le volume du son: * <listing version="3.0" > * * var mySound:Sound = new Sound(); * mySound.setVolume(VOL_HIGH); * </listing> */ |
| @includeExample | Inclu dans la documentation un exemple de code provenant d’un fichier externe dans l’élément concerné.
Si cette balise est placée dans le commentaire de classe, l’exemple sera en fin de page de documentation et un lien Examples sera créé dans le header de la page. /** * @includeExamples example_class.as */ |
| @exampleText | A utiliser uniquement dans des fichiers d’exemple externes.
Permet d’afficher du texte dans la documentation juste avant le code d’exemple ou juste après selon si la balise est utilisée dans le commentaire de classe ou dans un commentaire après le bloc de classe. /** * Ce text ne sera pas dans la doc. * @exampleText Celui ci bien. */ |
| @inheritDoc | Utilisez cette balise pour commenter une méthode ou une propriété Overridée. Elle copie le commentaire, les balsies @param et @return de la super classe vers la sous classe et ignore les autres balises.
Vous pouvez mettre un commentaire avant l’appel de cette balise. /** * @inheritDoc */ |
| @internal | Cache le texte qui suit cette balise qui ne sera pas dans la doc. Elle est utilisée pour les commentaires qui ne doivent être visibles que dans le code.
/** * @internal Ce texte n'apparaitra pas dans la doc */ |
| @param | Ajoute la description du paramètre. Le nom du paramètre doit être placé derrière, suivit de la description. le nom doit être identique que celui dans la signature.
/** * @param nomParam Description du paramètre */ |
| @private | Exclu l’élément concerné de la génération de documentation.
Pour exclure toute une classe, il doit être placé dans le commentaire de classe. Pour exclure un membre de la classe, il doit être placé dans le commentaire de ce membre. /** * @private */ |
| @return | Ajoute une section Return à la documentation de l’élément avec le texte qui suit cette balise.
ASDoc détermine tout seul le type du return d’après l’analyse du code. /** * @return La somme des paramètres */ |
| @see | Ajoute un lien vers quelque chose, voir le tableau See pour toutes les syntaxes possibles. |
| @throws | Ajoute la description d’une erreur quand une méthode implémente “throw”
/** * @throws Description de l'erreur */ |