JSDoc:如何声明一个闭包变量(在外部作用域的嵌套函数中可用)?

时间:2017-11-02 16:54:41

标签: javascript jsdoc

假设我有一个嵌套函数,并且想要记录它正在使用外部作用域中的变量的事实。我在JSDoc中使用什么注释?

示例:

GetDCEx()

1 个答案:

答案 0 :(得分: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);
    }

}