Google Closure Javascript的文档生成器

时间:2010-05-31 13:56:22

标签: documentation-generation google-closure

我想为我的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代码的特定工具?

2 个答案:

答案 0 :(得分:1)

该格式称为“JsDoc”。您可以使用http://code.google.com/p/jsdoc-toolkit/

将带有JsDoc注释的javascript转换为HTML

答案 1 :(得分:1)

更好的是使用上一版本(3.2.0)https://github.com/jsdoc3/jsdoc 它理解几乎所有的Closure注释。我正在将它用于http://estejs.com文档。