← Back to rules

jsdoc/require-property-type 正确性

它的作用

要求每个 @property 标记都必须包含类型值（使用花括号括起来）。

为什么这是问题？

属性的类型应该被记录。

示例

此规则的错误代码示例：

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

此规则的正确代码示例：

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

如何使用

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

配置 (.oxlintrc.json)

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

CLI

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

参考资料

• 规则源码