JSDoc

JSDoc peut produire la documentation dans un grand nombre de formats à base de texte comme HTML, XML, JSON, et ainsi de suite.

JSDoc a été précédemment sait que jsdoc Toolkit.

Les versions anciennes de Java jsdoc utilisés pour analyser le code source, extraire commentaires et de générer la documentation. Depuis la branche 3.x Node.js est utilisé à la place.

Outre Node.js, JSDoc peut aussi fonctionner avec le moteur Rhino de Mozilla ainsi.

Pour utiliser JSDoc correctement, vérifiez sa documentation pour obtenir des informations sur la façon de formater vos commentaires de code source afin qu'ils puissent être détectés et utilisés par le moteur de JSDoc.

Ce qui est nouveau dans cette version:.

• pouvez maintenant exécuter JSDoc sur Node.js
• pouvez maintenant utiliser lesinterface etimplements balises pour documenter les interfaces et leurs implémentations.
• inheritDoc etOverride les balises de fermeture du compilateur sont désormais pris en charge.
• Si le commentaire de JSDoc pour un symbole inclut la balise demixes, tous les mixins apparaissent maintenant dans la documentation du symbole.
• JSDoc informations peuvent désormais se connecter à la console car il fonctionne (par exemple, le nom de chaque fichier qui JSDoc analyse). Pour connecter ces informations, JSDoc courir avec le drapeau --verbose.
• pouvez maintenant utiliser n'importe quel fichier en tant que l'emballage ou le fichier README pour votre documentation. Utilisez les -P / - ensemble / et -R / -. Drapeaux readme pour spécifier le fichier de package et README
• la typographie et la couleur du régime des modèle par défaut ont été considérablement améliorée.

Ce qui est nouveau dans la version 3.3.2:

• pouvez maintenant exécuter JSDoc sur Node.js.
• pouvez maintenant utiliser lesinterface etimplements balises pour documenter les interfaces et leurs implémentations.
• inheritDoc etOverride les balises de fermeture du compilateur sont désormais pris en charge.
• Si le commentaire de JSDoc pour un symbole inclut la balise demixes, tous les mixins apparaissent maintenant dans la documentation du symbole.
• JSDoc informations peuvent désormais se connecter à la console car il fonctionne (par exemple, le nom de chaque fichier qui JSDoc analyse). Pour connecter ces informations, JSDoc courir avec le drapeau --verbose.
• pouvez maintenant utiliser n'importe quel fichier en tant que l'emballage ou le fichier README pour votre documentation. Utilisez les -P / - ensemble / et -R / -. Drapeaux readme pour spécifier le fichier de package et README
• la typographie et la couleur du régime des modèle par défaut ont été considérablement améliorée.

Ce qui est nouveau dans la version 3.3.0:

• pouvez maintenant exécuter JSDoc sur Node.js.
• pouvez maintenant utiliser lesinterface etimplements balises pour documenter les interfaces et leurs implémentations.
• inheritDoc etOverride les balises de fermeture du compilateur sont désormais pris en charge.
• Si le commentaire de JSDoc pour un symbole inclut la balise demixes, tous les mixins apparaissent maintenant dans la documentation du symbole.
• JSDoc informations peuvent désormais se connecter à la console car il fonctionne (par exemple, le nom de chaque fichier qui JSDoc analyse). Pour connecter ces informations, JSDoc courir avec le drapeau --verbose.
• pouvez maintenant utiliser n'importe quel fichier en tant que l'emballage ou le fichier README pour votre documentation. Utilisez les -P / - ensemble / et -R / -. Drapeaux readme pour spécifier le fichier de package et README
• la typographie et la couleur du régime des modèle par défaut ont été considérablement améliorée.

Quoi de neuf dans la version 3.2.2 / 3.3.0-beta1:

• Correction d'un régression JSDoc 3.2.1 qui pourrait empêcher une déclaration de fonction à partir de l'observation d'une déclaration du même nom dans une portée externe.
• Si une classe de l'enfant l'emporte sur une méthode dans une classe de parent sans documenter la méthode surchargée, la documentation de la méthode est copiée à partir de la classe parente.
• Vous pouvez maintenant utiliser des balises HTML dans le texte inline Markdown-formaté. En outre, JSDoc utilise maintenant seulement le Markdown analyseur marquée; l'analyseur de démarque-js a été supprimé.
• Type expressions peuvent désormais inclure un éventail beaucoup plus large de types reproductibles. En outre, vous pouvez maintenant utiliser les modificateurs nullables et non nullables de fermeture du compilateur avec des types reproductibles. Par exemple, le type d'expression ...! String (répétable, chaîne non nulle) est maintenant analysée correctement.

Ce qui est nouveau dans la version 2.4.0:

• Correction d'un bug qui a ajouté mutiple symboles avec le même nom docs.
• Ajout du support pour l'option -m pour supprimer les avertissements pour plusieurs docs.
• Ajout patch par brownsea42 pour soutenir variables utilisateur cotés sur la ligne de commande.
• Correction d'un bug qui provoquait parfois des liens à des événements pour être incorrecte.

Exigences :

• JavaScript côté client
• Node.js 0.10 ou supérieur