JSDoc 3

Cet article est une ébauche à compléter. Une ébauche est une entrée ayant un contenu (très) maigre et qui a donc besoin d'un auteur.

JSDoc 3 est un générateur automatique de documentation pour le langage JavaScript, similaire à JavaDoc pour Java ou PHPDoc pour PHP. Lors de la génération de la documentation, l'outil JSDoc scanne le code source, et génère un site web complet de documentation au format HTML à partir des commentaires écrits précédemment dans le code source.

Syntaxe

Tags

Tags ou mots-clé les plus couramment utilisés pour documenter son code:

Tag ou mot-clé	Description
@author	Indique le nom du développeur.
@class	Caractérise une fonction comme étant un constructeur qui retourne une instance.
@constant	Documente la fonctionnalité de la constante.
@copyright	Indique les droits d'auteur.
@deprecated	Indique que cette partie du code est dépréciée.
@param	Documente le paramètre de la fonction, y comprit son type de donnée.
@returns	Documente la valeur de retour, ainsi que son type de donnée.
@see	Lie à d'autres informations ou documentations complémentaires.
@throws	Décrit quels erreurs peuvent être levée.
@todo	Indique la documentation à compléter encore.
@version	Documente le numéro de version courante.

Intégration

Brackets

FuncDocr: extension intégrée à Brackets pour générer de la documentation JSDoc ou PHPDoc.

Alternatives

Autres générateurs automatiques disponibles en JavaScript:

• Docco
• YUIDoc

Articles de comparaison de ces différents générateurs automatiques de documentation:

• Choosing a JavaScript Documentation Generator – JSDoc vs YUIDoc vs Doxx vs Docco - 4 décembre 2013 - Kaustav Das Modak
• The best documentation generator for Node - 31 janvier 2014 - Junda Ong
• Top JavaScript Documentation Generators - 1 avril 2015 - Ashis Mohanty

Liens

JSDoc 3