jsdoc/require-property-description 正确性

它做了什么

要求所有 @property 标记都有说明文字。

这有什么不好？

属性的说明文字应当记录下来。

示例

此规则 错误 的代码示例

/**
 * @typedef {SomeType} SomeTypedef
 * @property {number} foo
 */

此规则 正确 的代码示例

/**
 * @typedef {SomeType} SomeTypedef
 * @property {number} foo Foo.
 */

引用

• 规则来源