jsDoc命名空间引用

时间:2015-09-12 07:33:50

标签: javascript node.js jsdoc

我有两个NodeJS模块,每个模块都在自己的文件中。其中一个声明了一个命名空间:

/**
 * @namespace module:formatting.formatAs
 */
var formatAs = {
    /**
     * @method myMethod
     * @memberof module:formatting.formatAs
     */
    myMethod: function () {
    }
};

/**
 * Formatting Module
 * @module formatting
 */
module.exports = {
    as: formatAs
};

另一个模块有一个属性 - 对命名空间的引用:

var localObj = {
    /**
     * @alias module:formatting.formatAs format
     */
    format: formatting.as
};

我已经尝试了所有内容以获得适当的参考,包括显示的alias,但似乎没有任何效果。

如何正确提供此类命名空间引用?

0 个答案:

没有答案