特殊单例模式的 JSDoc

Question

我有一个专门的JS单例原型函数

模式看起来或多或少像下面的例子。很好地完成工作，但遗憾的是 PhpStorm 对自动完成和其他有用的事情完全视而不见。

如何使用 JSDoc 告诉 IDE new Item 将导致使用 ItemPrototype 构建新对象的结束，因此 new Item(1).getId() 将指向代码中的正确位置？

提前感谢您的宝贵时间。

var Item = (function(){
    var singletonCollection = {};

    var ItemPrototype = function(id){

        this.getId = function() {
            return id;
        };

        return this;
    };

    var Constructor = function(id){
        if (! (id in singletonCollection)) {
            singletonCollection[id] = new ItemPrototype(id);
        }

        return singletonCollection[id];
    };

    return Constructor;
})();

Answer 1

您可以尝试以下方法：

/**
 * A description here
 * @class
 * @name Item
 */
var Item = (function(){
    var singletonCollection = {};

    var ItemPrototype = function(id){
        /**
         * method description
         * @name Item#getId
         */
        this.getId = function() {
            return id;
        };

        return this;
    };

    var Constructor = function(id){
        if (! (id in singletonCollection)) {
            singletonCollection[id] = new ItemPrototype(id);
        }

        return singletonCollection[id];
    };

    return Constructor;
})();

特殊单例模式的 JSDoc

JSDoc for special singleton pattern

javascript

jsdoc

phpstorm

webstorm