Генератор документации для Google Closure Javascript

Question

Я хочу создать HTML-документацию для моего кода Javascript.Комментарии в моем коде написаны в формате, который компилятор Google Closure может использовать для оптимизации моего кода.

Пример:

/**
 * 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

Лучше использовать последнюю версию (3.2.0) https://github.com/jsdoc3/jsdoc Он понимает почти все аннотации закрытия. Я использую это для http://estejs.com документации.

Answer 2

Этот формат называется "JsDoc". Вы можете конвертировать JsDoc-аннотированный JavaScript в HTML используя http://code.google.com/p/jsdoc-toolkit/