« JSDoc 3 » : différence entre les versions
Aller à la navigation
Aller à la recherche
m (Ajout de liens) |
mAucun résumé des modifications |
||
| (3 versions intermédiaires par un autre utilisateur non affichées) | |||
| Ligne 1 : | Ligne 1 : | ||
{{ | {{Ebauche}} | ||
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 | 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. | ||
== Installation == | == Installation == | ||
== Syntaxe == | == Syntaxe == | ||
=== Tags === | === Tags === | ||
Tags ou mots-clé les plus couramment utilisés pour documenter son code: | |||
:{| class="wikitable" | |||
! Tag ou mot-clé !! Description | |||
|- | |||
|[http://usejsdoc.org/tags-author.html @author] || Indique le nom du développeur. | |||
|- | |||
|[http://usejsdoc.org/tags-class.html @class] || Caractérise une fonction comme étant un constructeur qui retourne une instance. | |||
|- | |||
|[http://usejsdoc.org/tags-constant.html @constant] || Documente la fonctionnalité de la constante. | |||
|- | |||
|[http://usejsdoc.org/tags-copyright.html @copyright] || Indique les droits d'auteur. | |||
|- | |||
|[http://usejsdoc.org/tags-deprecated.html @deprecated] || Indique que cette partie du code est dépréciée. | |||
|- | |||
|[http://usejsdoc.org/tags-param.html @param] || Documente le paramètre de la fonction, y comprit son type de donnée. | |||
|- | |||
|[http://usejsdoc.org/tags-returns.html @returns] || Documente la valeur de retour, ainsi que son type de donnée. | |||
|- | |||
|[http://usejsdoc.org/tags-see.html @see] || Lie à d'autres informations ou documentations complémentaires. | |||
|- | |||
|[http://usejsdoc.org/tags-throws.html @throws] || Décrit quels erreurs peuvent être levée. | |||
|- | |||
|[http://usejsdoc.org/tags-todo.html @todo] || Indique la documentation à compléter encore. | |||
|- | |||
|[http://usejsdoc.org/tags-version.html @version] || Documente le numéro de version courante. | |||
|} | |||
=== Exemples === | === Exemples === | ||
== Génération de documentation == | == Génération de documentation == | ||
| Ligne 15 : | Ligne 42 : | ||
* [http://jashkenas.github.io/docco/ Docco] | * [http://jashkenas.github.io/docco/ Docco] | ||
* [http://yui.github.io/yuidoc/ YUIDoc] | * [http://yui.github.io/yuidoc/ YUIDoc] | ||
Articles de comparaison de ces différents générateurs automatiques de documentation: | |||
* [http://blog.fusioncharts.com/2013/12/jsdoc-vs-yuidoc-vs-doxx-vs-docco-choosing-a-javascript-documentation-generator/ Choosing a JavaScript Documentation Generator – JSDoc vs YUIDoc vs Doxx vs Docco] - 4 décembre 2013 - [http://blog.fusioncharts.com/author/kaustav/ Kaustav Das Modak] | |||
* [http://samwize.com/2014/01/31/the-best-documentation-generator-for-node/ The best documentation generator for Node] - 31 janvier 2014 - [http://samwize.com/ Junda Ong] | |||
* [http://www.uitrick.com/javascript/top-javascript-documentation-generators/ Top JavaScript Documentation Generators] - 1 avril 2015 - [http://www.uitrick.com/author/admin/ Ashis Mohanty] | |||
== Liens == | == Liens == | ||
[http://usejsdoc.org/ JSDoc 3] | [http://usejsdoc.org/ JSDoc 3] | ||
[[Catégorie:JavaScript]] | |||
Dernière version du 23 mars 2016 à 14:23
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.
Installation
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.
Exemples
Génération de documentation
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:
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