Jsdoc命名空间与揭示模块模式

时间:2015-09-01 17:33:49

标签: jsdoc3

我试图让命名空间与显示模块模式一起工作。我的代码看起来类似于以下内容:

/**
* @namespace bigpage
*/
var bigpage = {};

/**
* @namespace bigpage.data.methods
* @memberOf bigpage.data
*/

bigpage.data.methods = bigpage.data.methods || (function() {
    /**
    * @function
    * @memberOf bigpage.data.methods
    * @param {string} 
    */
    function getDataSeller(method) {
    }
    return { getDataSeller : getDataSeller };
 })();

然而,JSdoc并没有看到拿起getDataSeller文档。如果有人能给我一个这样做的方法,以及为什么上述工作不起作用,那就太棒了。

1 个答案:

答案 0 :(得分:1)

我发现此链接非常有用: http://devnull.absolventa.de/2014/03/25/jsdoc-and-the-revealing-module-pattern/

// In file: namespace.js
(function() {
    window.Absolventa = window.Absolventa || {};
}());

// In file: modules/urlify.js
(function() {
    "use strict";
    Absolventa.Urlify = (function() {
        var init;

        /**
         * @param {string} foo
         */
        init = function(foo) {
          // Magick!
        };

        return {
          init : init
        };
    }());
}());

到目前为止,我们已经看到了一些初步的成功。我还没有在我们的所有代码中完全实现它,但我已经在我们最嵌套的代码上使用它,它似乎正在工作(使用JSDoc3)