假设我有一个嵌套函数,并且想证明它使用的是外部作用域中的变量。我在JSDoc中使用什么注释?

例:

var Constructor = function () {
    var externalVariable = "foo";

    /**
     * This method does whatever it does.
     *
     * @?????? {string} externalVariable - closure variable from outer scope
     */
    this.method = function() {
        console.log(externalVariable);
    }

}

最佳答案

我不知道这是否是正确的方法,但是我记录了外部变量,并在公开的方法中对其进行了引用。

var Constructor = function () {

    /**
     * @private
     * @alias externalVariable
     * @type {String}
     */
    var externalVariable = "foo";

    /**
     * This method does whatever it does.
     *
     * @see externalVariable
     */
    this.method = function() {
        console.log(externalVariable);
    }

}

07-24 09:30