jQuery compatible JavaScript générateur de documentation

Question

J'ai besoin de choisir un générateur de documentation (similaire à jdoc en java ou rdoc en ruby) pour mon projet javascript qui (construit avec jquery, un trait de soulignement et de la colonne vertébrale)

Les candidats:

• jsdoc toolkit
• pdoc
• naturel docs
• docco
• YUI doc
• doctool http://jquery.bassistance.de/docTool/docTool.html
• les autres ?

Exigences

• devrait fonctionner avec jquery, un trait de soulignement et de la colonne vertébrale. cela signifie que l'objet littéral des méthodes, etc
• Je vraiment comme pdoc, mais c'est trop centrée autour de prototype, mal documenté, et je ne veux pas faire des fichiers supplémentaires (articles?) pour le faire fonctionner (pas sûr à ce sujet)
• docco est gentil, mais je veux une sortie structurée (comme dans menu + classe/structure func comme jdoc)
• doit être la ligne de commande/makefile compatible (non web pastie)

Des conseils, des astuces, des tutoriels, des histoires à succès, des conseils très bien accueillie.

---

Pourquoi Ne pas utiliser jQuery JSDoc?

Answer 1

Je dirais jsduck de Sencha sur le dessus. Je l'ai utilisé sur de nombreux projets. Simple à utiliser

https://github.com/senchalabs/jsduck

Une seule commande va générer des docs comme ça http://docs.sencha.com/touch/2-0/

Answer 2

Vous pouvez consulter également Dox par TJ Holowaychuk; c'est un fork de Docco, mais ajoute quelques jsDoc en charge de la syntaxe. Personnellement, je trouve que jQuery souvent se prête à de perdant de style en ligne de la documentation comme Docco, mais je suis actuellement dans la même situation, en essayant de décider ce doc système à utiliser.

Answer 3

Je vais dans le même exercice pour le moment, et à partir de ce que j'ai vu YUI Doc est le meilleur. J'aime le fait que vous pouvez l'exécuter en mode "serveur", et consultez la documentation comme vous l'écrivez. Beaucoup mieux que d'avoir à exécuter une build à chaque fois que vous modifiez la documentation. En outre, la documentation qui est généré est très facile à lire et très bien organisé.

Answer 4

Ce qui est nouveau, de sorte qu'il peut ne pas convenir à vos besoins en matière de sortie, mais vous pourriez trouver njsdoc intéressant. Contrairement à la plupart des JS "documenteurs" il essaie de génération de la documentation par l'exécution du code et de l'enquête de la pile plutôt que de simplement l'analyse les fichiers pour les annotations.

https://bitbucket.org/nexj/njsdoc

Answer 5

Il est DocumentJS*

*Je ne l'ai pas utilisé et je ne suis pas sûr de savoir comment il va s'intégrer avec la colonne vertébrale.