documentation-generation - Google Closure Javascript 的文档生成器

Question

我想为我的 Javascript 代码生成 HTML 文档。我的代码中的注释以某种格式编写，Google Closure Compiler 可以使用它来优化我的代码。

例子：

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

我正在为 Javascript寻找类似http://yardoc.org的东西。

您可以推荐哪些工具？Google Closure 代码是否有任何特定工具？

Answer 1

该格式称为“JsDoc”。您可以使用http://code.google.com/p/jsdoc-toolkit/从 JsDoc 注释的 javascript 转换为 HTML

Answer 2

更好的是使用最新版本（3.2.0）https://github.com/jsdoc3/jsdoc 它几乎可以理解所有 Closure 注解。我将它用于http://estejs.com文档。