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

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

您可以推荐哪些工具？是否有针对 Google Closure 代码的特定工具？

Answer 1

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