Tags d'annotation jsdoc-toolkit
Les tags d'annotation sont très important car c'est grâce à eux que la documentation est lisible.
On les insert dans un commentaire au dessus de la fonction ou la variable Javascript :
*
*
*/
Les tags d'annotation sont préfixés par un @
Les tags d'annotation les plus classiques :
- @param : correspond a un paramètre passé a une fonction
- @returns : décrit ce que retourne la variable ou la fonction
- @constructor : c'est un constructeur
- ...
Je vous laisse découvrir la documentation des tags d'annotation jsdoc-toolkit .
* Retourne la valeur Bla bla ...
* @param String str blabla.
* @returns String blabla.
*/
function mafonction(str) {
return str;
}
Voir le site : http://code.google.com/p/jsdoc-toolkit/wiki/TagReferenceOn les insert dans un commentaire au dessus de la fonction ou la variable Javascript :
Exemple de code :
/***
*
*/
Les tags d'annotation sont préfixés par un @
Les tags d'annotation les plus classiques :
- @param : correspond a un paramètre passé a une fonction
- @returns : décrit ce que retourne la variable ou la fonction
- @constructor : c'est un constructeur
- ...
Je vous laisse découvrir la documentation des tags d'annotation jsdoc-toolkit .
Exemple de code :
/** * Retourne la valeur Bla bla ...
* @param String str blabla.
* @returns String blabla.
*/
function mafonction(str) {
return str;
}
