Google Closure Javascript 的文档生成器答案

【问题标题】：Documentation generator for Google Closure JavascriptGoogle Closure Javascript 的文档生成器
【发布时间】：2010-05-31 13:56:21
【问题描述】：

我想为我的 Javascript 代码生成 HTML 文档。我的代码中的 cmets 是以一种格式编写的，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) {
...
}

我正在寻找类似 @987654321@ 的 JavaScript 代码。

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

【问题讨论】：

标签： documentation-generation google-closure

【解决方案1】：

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

【讨论】：

【解决方案2】：

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

【讨论】：