如何使用JSDoc描述类方法影响实例属性

时间:2019-11-29 09:31:21

标签: javascript class jsdoc

有没有办法描述changeBar影响实例的bar属性?

这是文档过多吗?

/**
 * @class Foo
 * @property {string} bar - class property
 */
class Foo {
  constructor() {
    this.bar = 'default'
  }

  /**
   * Changes bar status.
   */
  changeBar() {
    this.bar = 'changed'
  }
}

0 个答案:

没有答案