javascript - JSDoc:如何声明闭包变量(可在外部作用域的嵌套函数中使用)？

Question

假设我有一个嵌套函数，并且想要记录它使用外部作用域中的变量的事实。我在 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);
    }

}

Answer 1

我不知道这是否是正确的方法，但我会记录外部变量并在公开的方法中引用它。

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);
    }

}