文档生成 – Google Closure Javascript的文档生成器

2019年8月1日 185次阅读

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

最佳答案 该格式称为“JsDoc”.您可以使用
http://code.google.com/p/jsdoc-toolkit/将JsDoc-annotated javascript转换为HTML

点赞