Générateur de documentation pour Google Closure Javascript

Question

Je souhaite générer une documentation HTML pour mon code Javascript. Les commentaires dans mon code sont écrits dans un format, le compilateur Google Closure peut utiliser pour optimiser mon code.

Exemple:

/** 
* 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) { 
... 
} 

Je cherche quelque chose comme http://yardoc.org pour Javascript.

Quels outils pouvez-vous recommander? Existe-t-il des outils spécifiques pour le code Google Closure?

Answer 1

Ce format est appelé "JsDoc". Vous pouvez convertir javascript annotée jsdoc à HTML en utilisant http://code.google.com/p/jsdoc-toolkit/

Answer 2

Le mieux est d'utiliser dernière version (3.2.0) https://github.com/jsdoc3/jsdoc Il comprend presque toutes les annotations de fermeture. Je l'utilise pour la documentation http://estejs.com.