← Back to rules

jsdoc/require-property 正确性

An auto-fix is available for this rule.

它做了什么

当 @typedef 和 @namespace 标签的类型为普通对象（即 object、Object 或 PlainObject）时，要求必须包含 @property 标签。

注意：此规则可以通过 jsdoc 设置 选项进行配置。

为什么这是不好的？

对象类型应当定义其属性。

示例

此规则的 错误 代码示例：

/**
 * @typedef {Object} SomeTypedef
 */

/**
 * @namespace {Object} SomeNamesoace
 */

此规则的 正确 代码示例：

/**
 * @typedef {Object} SomeTypedef
 * @property {SomeType} propName 属性描述
 */

/**
 * @typedef {object} Foo
 * @property someProp
 */

如何使用

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

配置文件 (.oxlintrc.json)

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

CLI

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

参考资料

• 规则源码