Gibt es eine Möglichkeit Javascript-API-Dokumentation, wie die Google Closure-Bibliothek API-Dokumentation zu generieren?

Question

Ich versuche, ein Werkzeug zu finden, die für meine Javascript HTML-Dokumentation Quellcode erzeugt.

Wer weiß, wenn das Werkzeug, dass Google die Schnittstelle zu den folgenden URLs zu erzeugen, verwendet, ist Open Source? Würde ich eine ähnliche Ausgabe generieren können?

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

Ich bin mir dessen bewusst http://code.google.com/p/jsdoc- Toolkit /

Aber ich möchte, wenn der spezifische Generator wissen, dass Google verwendet zur Verfügung steht für mich für meine eigene Quelle zu verwenden (die Open-Source sein wird, wenn diese Fragen).

Vielen Dank im Voraus ...

Answer 1

Google Closure + JSDoc

Wie Sie sich in Ihrem Kommentar erwähnt, bauen sie auf JSDoc Toolkit spezielle Anmerkungen durch den Closure Compiler für die Typprüfung und andere Dinge verwendet hinzuzufügen, aber das bedeutet auch nur JSDoc auf der Schließung Code Ihre Dokumentation zu erzeugen, verwenden kann. eine Ausgabe mit dem gewünschten Aussehen und das Gefühl zu erzeugen ist dann nur eine Frage der eigene Vorlage und Sheet zu schreiben.

Die Google Closure Werkzeuge sind alle Open Source mit Ausnahme einiger Bits, die nicht in dem Moment offenbart. In jedem Fall können Sie einen Blick in die Dokumentation und den Quellcode haben und sehen, was sie Javadocs zu erzeugen, verwendet werden.

ExtJS + Ext-Doc

Ein anderer könnte man vielleicht einen Blick auf Inspiration und sehen, wie sie tun, es ist die Ext-Doc erzeugt Dokumentation mit einem ähnlichen Stil, obwohl es ist jetzt ein bisschen veraltet.

YUI Doc

wie von Matthew Manela erwähnt, YUI Doc produziert ziemlich gute Online-Dokumentation.

Mein Rat wäre für JSDoc zu gehen, wie es der de-facto-Standard für viele Werkzeuge und es spiegelt Java Praktiken, aber es ist wirklich an, was Sie wollen.

Answer 2

Schauen Sie sich YUI Doc .

Answer 3

Für die, die unter Verwendung von ExtJS, https://github.com/senchalabs/jsduck ist genial.

Für die, die nicht ExtJS verwenden, aber vertraut mit Ruby https://github.com/b -studios / doc.js groß ist.

Answer 4

Eine neuere Möglichkeit ist, http://documentation.js.org/ die JSDoc verwendet und erzeugt HTML :

Sie können es laufen mit großen Schluck https://github.com/documentationjs/gulp-documentation

Answer 5

Dossier ist derzeit (2016) verwendet wird, die Closure-Dokumentation . Es ist ein fantastisches Werkzeug, das auf der Oberseite des Closure Compiler selbst gebaut, so dass es alle tatsächlich liest die Typinformationen unter Verwendung des Compilers und gibt dann Dokumentation anstelle des Codes.

Es gibt noch einige Dinge werden über die Benutzeroberfläche der docs erarbeitet. Derzeit dass docs Seite sieht Closure Bibliothek ziemlich leer -. Sie auf dem „Hamburger-Menü“ Symbol klicken haben in oberen loszulegen links nach