jsdoc/require-property-description 正确性

要求所有 @property 标签都必须有描述。

属性的描述应当被记录。

此规则的错误代码示例：

javascript

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

此规则的正确代码示例：

javascript

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

如何使用

要通过配置文件或 CLI 启用此规则，可以使用：

配置 (.oxlintrc.json)CLI

json

{
  "plugins": ["jsdoc"],
  "rules": {
    "jsdoc/require-property-description": "error"
  }
}

bash

oxlint --deny jsdoc/require-property-description --jsdoc-plugin