this - 如何在 JSDoc 3 标签 : @this 中记录对象的属性

Question

@param标签允许记录属性，例如

 /**
  * @param {Object} userInfo Information about the user.
  * @param {String} userInfo.name The name of the user.
  * @param {String} userInfo.email The email of the user.
  */

我将如何记录@this 标签的属性？

 /**
  * @this {Object} 
  * @param {String} this.name The name of the user.
  * @param {String} this.email The email of the user.
  */

我想知道是否有从事该项目的人知道。 (文档仍在创建中...)

Answer 1

要记录实例成员，请使用 @name Class#member :

/**
 * Construct a new component
 *
 * @class Component
 * @classdesc A generic component
 *
 * @param {Object} options - Options to initialize the component with
 * @param {String} options.name - This component's name, sets {@link Component#name}
 * @param {Boolean} options.visible - Whether this component is visible, sets {@link Component#visible}
 */
function Component(options) {
   /**
    * Whether this component is visible or not
    *
    * @name Component#visible
    * @type Boolean
    * @default false
    */
    this.visible = options.visible;

   /**
    * This component's name
    *
    * @name Component#name
    * @type String
    * @default "Component"
    * @readonly
    */
    Object.defineProperty(this, 'name', {
        value: options.name || 'Component',
        writable: false
    });
}

这会导致 成员(member)文档中列出了每个成员、其类型、默认值以及它是否为只读的部分。
jsdoc@3.3.0-alpha3 生成的输出如下所示:

也可以看看:

JSDoc namepaths

@instance tag

@readonly tag

@type tag