Existe-t-il un moyen de générer la documentation de l'API Javascript comme la documentation de l'API Google Closure Library?

Question

Je vais essayer de trouver un outil qui génère du code HTML de la documentation pour mon code source Javascript.

Personne ne sait si l'outil que Google utilise pour générer l'interface à l'Url ci-après est open source? Serais-je capable de générer le même résultat?

http://closure-library.googlecode.com/svn/docs/class_goog_proto2_Serializer.html

http://closure-library.googlecode.com/svn/docs/namespace_goog_date.html

http://closure-library.googlecode.com/svn/docs/namespace_goog_events.html

http://closure-library.googlecode.com/svn/docs/class_goog_gears_Database.html

http://closure-library.googlecode.com/svn/docs/class_goog_ui_DatePicker.html

Je suis conscient de http://code.google.com/p/jsdoc-toolkit/

Mais je voudrais savoir si le générateur est utilisé par Google est disponible pour moi de l'utiliser pour mon propre source (qui va être open source, si ce qui compte).

Merci à l'avance...

Answer 1

Google Fermeture + JSDoc

Comme vous l'avez mentionné vous-même dans votre commentaire, ils s'appuient sur JSDoc Trousse d'outils pour ajouter des annotations utilisées par le Compilateur de Fermeture pour la vérification de type et d'autres choses, mais cela signifie que vous pouvez simplement utiliser JSDoc sur le haut de la fermeture de code pour générer la documentation. Générer une sortie avec le look désiré et la sensation est qu'une question de rédiger votre propre modèle et la feuille de style.

Le Google Fermeture Outils sont open source, sauf pour les quelques morceaux qui ne sont pas divulgués pour le moment. Dans tous les cas, vous pouvez avoir un coup d'oeil à la documentation et le code source et de voir ce qu'ils utilisent pour générer la documentation Javadoc.

ExtJS + Ext-Doc

Un autre que vous pourriez éventuellement avoir un coup d'oeil à l'inspiration et à voir comment ils le font c'est la doc en ligne pour ExtJS. Je trouve ça un peu difficile d'accès au premier abord, mais on s'habitue assez rapidement. Un projet open source, Ext-Doc, génère des documents avec un style similaire, mais il est maintenant un peu dépassé.

YUI Doc

Tel que mentionné par Matthieu Manela, YUI Doc donnent une assez bonne documentation en ligne.

Mon conseil serait d'aller pour JSDoc comme c'est le standard de facto pour de nombreux outils et il reflète Java pratiques, mais c'est vraiment jusqu'à ce que vous voulez.

Answer 2

Découvrez YUI Doc .

Answer 3

Pour ceux qui utilisent ExtJs, https://github.com/senchalabs/jsduck est génial.

Pour ceux qui n'utilisent pas ExtJS mais qui connaissent Ruby, https://github.com/b-studios/doc.js est génial.