Dokumentations-Generator für Google Closure Javascript

Question

Ich möchte eine HTML-Dokumentation für den Javascript-Code generieren. Die Kommentare in meinem Code in einem Format geschrieben, kann die Google Closure Compiler verwenden, um meinen Code zu optimieren.

Beispiel:

/**
 * Class for handling timing events.
 *
 * @param {number=} opt_interval Number of ms between ticks (Default: 1ms).
 * @param {Object=} opt_timerObject  An object that has setTimeout, setInterval,
 *     clearTimeout and clearInterval (eg Window).
 * @constructor
 * @extends {goog.events.EventTarget}
 */
goog.Timer = function(opt_interval, opt_timerObject) {
...
}

Ich bin auf der Suche nach so etwas wie http://yardoc.org für Javascript.

Was Tools können Sie empfehlen? Gibt es spezielle Werkzeuge für die Google Closure-Code?

Answer 1

Das Format ist "JsDoc" genannt. Sie können von JsDoc-kommentierten Javascript in HTML konvertieren mit http://code.google.com/ p / jsdoc-Toolkit /

Answer 2

Je besser ist letzte Version zu verwenden (3.2.0) https://github.com/jsdoc3/jsdoc Es versteht fast alle Closure Anmerkungen. Ich verwende es für http://estejs.com Dokumentation.