使用jsdoc3记录模块和子模块

Question

我有一个遵循此模式的模块。

/**
 *  @name Filters
 *  @namespace
 */
var Filters = (function (Filters, $) {
    Filters.switchView = function (newView) {
        // do something
    };
    return Filters;
})(Filters || {}, jQuery);

然后，我就有了Filters模块的子模块

Filters.validator = (function (Filters, $) {
    var validator = {};
    validator.toggleErrorState = function (state, el) {
         // do something
    } 
    return validator;
})(Filters || {}, jQuery);

我不知道如何文档子模块。我已经做了一些搜索，但没有发现任何其他遵循这种特殊模式的人正在使用jsdoc样式注释进行文档记录。任何帮助都将不胜感激。

Answer 1

这记录了这两个名称空间。第一个文件：

/**
 *  @namespace
 */
var Filters = (function (Filters, $) {
    /**
     * switchView does...
     * @param newView The new view.
     */
    Filters.switchView = function (newView) {
        // do something
    };
    return Filters;
})(Filters || {}, jQuery);

第二个文件：

/**
 * @namespace
 */
Filters.validator = (function (Filters, $) {
    var validator = {};
    /**
     * toggleErrorState does...
     * @param state The state.
     * @param el The el.
     */
    validator.toggleErrorState = function (state, el) {
         // do something
    }
    return validator;
})(Filters || {}, jQuery);

Answer 2

/**
 *  @namespace Parent
 */
var Filters = (function (Filters, $) {
    /**
     * switchView does...
     * @param newView The new view.
     */
    Filters.switchView = function (newView) {
        // do something
    };
    return Filters;
})(Filters || {}, jQuery);

/**
 * @namespace Child
 * @memberOf Parent
 */
Filters.validator = (function (Filters, $) {
    var validator = {};
    /**
     * toggleErrorState does...
     * @param state The state.
     * @param el The el.
     */
    validator.toggleErrorState = function (state, el) {
         // do something
    }
    return validator;
})(Filters || {}, jQuery);