如何在jsdoc中将模块分配给名称空间?

时间:2014-05-27 12:13:22

标签: javascript namespaces jsdoc javascript-namespaces

我们正在使用jsdoc进行一个非常重量级的项目。 为了获得代码文档,我们让jsdoc通过grunt构建html文件。

到目前为止,我们使用" memberof"成功地为模块分配了属性和方法。像这样的关键字:

示例

/**
 * Short description of this module
 *
 *
 * @module hse-catalog
 */
jQuery(document).ready(function($) {
    'use strict';

    /**
     * @namespace catalog
     * @memberof module:hse-catalog
     */
    catalog = {

        selector: {
            /* Stuff in here */
        },

        /**
         * Initializes the module.
         *
         * @memberof module:hse-catalog
         */
        init: function() {
            // do init
        },

        /**
         * Indicates whether the module is ready to load.
         *
         * @return {boolean} true or false
         * @memberof module:hse-catalog
         */
        isReady: function() {
            // do stuff
        }

        /**
         * Initializes the catalog page breadcrumb.
         * @deprecated out of order
         * @memberof module:hse-catalog
         */
        initBreadcrumb: function() {
            // do stuff
        }
    };
});

这为我们创建了一个非常好的html文档,其中列出了所有模块。如果我点击其中一个模块,我会看到这个模块的所有属性和方法。到目前为止一切都很好。

但真正的问题是我们还希望将模块分配给某些名称空间。我们怎么做? jsdoc是否支持这一点?

0 个答案:

没有答案