← Back to rules

jsdoc/check-property-names 正确性

An auto-fix is available for this rule.

它做了什么

确保 JSDoc 中的属性名称在同一块内不重复，并且嵌套属性具有明确的根节点。

为什么这是个问题？

具有相同名称的 @property 标签可能造成混淆，也可能表明存在错误。

示例

此规则的 错误 代码示例：

/**
 * @typedef {object} state
 * @property {number} foo
 * @property {string} foo
 */

/**
 * @typedef {object} state
 * @property {number} foo.bar
 */

此规则的 正确 代码示例：

/**
 * @typedef {object} state
 * @property {number} foo
 */

/**
 * @typedef {object} state
 * @property {object} foo
 * @property {number} foo.bar
 */

如何使用

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

配置文件 (.oxlintrc.json)

{
  "plugins": ["jsdoc"],
  "rules": {
    "jsdoc/check-property-names": "error"
  }
}

CLI

oxlint --deny jsdoc/check-property-names --jsdoc-plugin

参考资料

• 规则源码