javascript - "@name"的替代品，用于记录 `this` 的属性

Question

我想知道如何记录类的构造函数的 this. 属性。例如，我尝试使用 @name 标记来命名我的类，但它没有为 this.foo 生成文档:

/**
 * @name ClassName
 * @constructor
 */
function noname (){
    /** @type {String} */
    this.foo = "bar";
}

我可以这样解决:

/**
 * @name ClassName
 * @constructor
 */
function noname (){
    /** 
    * @type {String} 
    * @name ClassName#foo
    */
    this.foo = "bar";
}

或者这样:

/**
 * @name ClassName
 * @constructor
 */
function noname (){
    /** @lends ClassName# */
    var that = this;

    /** @type {String} */
    that.foo = "bar";
}

然而，两者都不令人满意，因为这要么需要更改大量现有代码，要么需要在 jsdoc 注释中添加所有属性名称。

既然 @name 不能解决问题，是否有替代标签可以解决问题？

Answer 1

尝试使用 @alias 标签:

/**
 * @alias ClassName
 * @constructor
 */
function noname (){
    /** @type {String} */
    this.foo = "bar";
}

一般来说，使用@alias标签重命名代码中存在的符号；如果您记录的符号没有出现在您的代码中(例如，在运行时生成的方法)，请使用 @name 标记。