module - jsdoc自执行匿名函数

Question

我如何使用 jsdoc 记录这样的模块？我尝试了很多版本，但无法使其工作。 Funciton 测试没有出现在文档中。

/**
 * Description of module, defines module for whole file
 *    
 * @module constructors
 * @exports app
 */


var app = (function() {
    /**
     * Description of function test
     */
    function test() {
        return '';
    }

    return {
        test: test
    }
}());

Answer 1

从版本 3.2.2 开始，jsdoc 很容易被模块绊倒，解决方案是使用 module: 和模块名称来指定您正在记录的实体所在的位置:

/**
 * Description of module, defines module for whole file
 *
 * @module constructors
 */

var app = (/** @lends module:constructors */ function() {
    /**
     * Description of function test
     */
    function test() {
        return '';
    }

    return {
        test: test
    }
}());