← Back to rules

jsdoc/require-property-description Correctness

功能说明

要求所有 @property 标签都包含描述。

为什么这很糟糕？

属性的描述应该被记录下来。

示例

以下是此规则的错误代码示例：

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

以下是此规则的正确代码示例：

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

如何使用

To enable this rule using the config file or in the CLI, you can use:

Config (.oxlintrc.json)

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

Config (oxlint.config.ts)

import { defineConfig } from "oxlint";

export default defineConfig({
  plugins: ["jsdoc"],
  rules: {
    "jsdoc/require-property-description": "error",
  },
});

CLI

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

版本

此规则于 v0.2.18 中添加。

参考资料

• Rule Source
• Open rule in Oxc Playground