记录"工厂构造"使用jsdoc的类

时间:2016-04-06 00:27:37

标签: javascript jsdoc3

我有一些跟随"Factory Constructor" pattern的课程。这些是通过致电工厂而不是使用new关键字构建的。

示例:

/**
 * Example "Factory Constructor" class
 * @class
 */
function MyClass() {

    return /** @lends MyClass.prototype */ {

        /** One method */
        method1: function() {  },

        /** Another Method */
        method2: function() {  }

    };

}

另请注意,工厂的名称与类的名称相同(与静态方法MyClass.create()不同)。

我的问题是jsdoc一直坚持要记录这个类应该用' new'构建,例如:

enter image description here

我已经查看了其他各种问题(例如this onethis one)和博客帖子(例如this one),但没有一个问题解决了这个问题。

我也尝试了一些变体,例如

/**
 * Example "Factory Constructor" class
 * @name MyClass
 * @constructs
 */

结果:产生与上述相同的输出

将MyClass记录为静态函数,如下所示:

/**
 * Example "Factory Constructor" class
 * @static
 */

结果:MyClass作为一个类完全消失,并且只显示为一个函数,可能正如您所期望的那样。

0 个答案:

没有答案