← Back to rules

jsdoc/require-property-name 正确性

它做了什么

要求所有 @property 标签都必须有名称。

为什么这是不好的？

属性类型的名称应当被文档化。

示例

此规则的错误代码示例：

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

此规则的正确代码示例：

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

如何使用

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

配置文件 (.oxlintrc.json)

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

CLI

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

参考资料

• 规则源码