使用jsdoc记录javascript构造函数的返回

Question

我有一个返回构造函数的javascript函数（见下面的代码示例）。我该如何用jsdoc的@returns标记来记录这一点。执行@returns{MyConstructor}似乎不正确，因为这意味着我返回的是“MyConstructor”的实例，而不是构造函数本身，对吗？

function MyConstructor() {
    var self = this;

    self.myFunction = function() {
        return true;
    };

    self.getMyFunctionResult = function() {
        return self.myFunction();
    };
}

/**
 * @returns {?} A constructor that will be instantiated
 */
function getConstructor() {
    return MyConstructor;
}

var constructor = getConstructor();
var instance = new constructor();

Answer 1

您可以使用以下方法检查函数返回的类型：

console.log(typeof constructor, typeof instance); // function object

留档里说：

/**
 * Returns the sum of a and b
 * @param {Number} a
 * @param {Number} b
 * @returns {Number} Sum of a and b
 */
function sum(a, b) {
    return a + b;
}

http://usejsdoc.org/tags-returns.html

因此，在您的示例中，它将是：

/**
 * Returns the MyConstructor class
 * @returns {Function} MyConstructor class
 */
function getConstructor() {
    return MyConstructor;
}

或者，如果您正在创建项目的实例：

/**
 * Returns an instance of the MyConstructor class
 * @returns {Object} MyConstructor instance
 */
function getInstance() {
    return new MyConstructor();
}

Answer 2

也许有点晚了，但我很难为今天的提问活动找到合适的答案。

当我尝试在WebStorm上自动生成JSDoc时，我得到的是：

class Test {}

/**
 *
 * @return {Test}
 * @constructor
 */
function getTestConstructor() {
    return Test;
}

返回类型定义仍然很奇怪，但构造函数注释可以达到目的。

Answer 3

我认为没有办法使用返回后的括号来记录返回的特定实例。括号中的内容始终被解释为类型。这就是说，有一种方法可以通过记录实例并使用实例链接来记录返回的特定类型实例。我已将问题中的代码缩短为必要的要点，以说明：

/**
 * @class
 */
function MyConstructor() {

}

/**
 * @returns {Function} A constructor that will be instantiated. Always
 * returns {@link MyConstructor}.
 */
function getConstructor() {
    return MyConstructor;
}

它也可以通过类以外的其他东西来实现：

/**
 * @public
 */
var foo = 1;

/**
 * @returns {number} {@link foo}.
 */
function getFoo(){
    return foo;
}

据我所知，这是与jsdoc 3一样好的。