jsdoc/require-property 正确性
作用
当 @typedef 和 @namespace 标记的类型为普通 object、Object 或 PlainObject 时， 要求它们具有 @property 标记。
注意：此规则可通过 jsdoc 设置 选项进行配置。
为什么这不好？
对象类型应该定义属性。
示例
以下是此规则的错误代码示例：
javascript
/**
* @typedef {Object} SomeTypedef
*/
/**
* @namespace {Object} SomeNamespace
*/以下是此规则的正确代码示例：
javascript
/**
* @typedef {Object} SomeTypedef
* @property {SomeType} propName 属性描述
*/
/**
* @typedef {object} Foo
* @property someProp
*/如何使用
To enable this rule using the config file or in the CLI, you can use:
json
{
"plugins": ["jsdoc"],
"rules": {
"jsdoc/require-property": "error"
}
}ts
import { defineConfig } from "oxlint";
export default defineConfig({
plugins: ["jsdoc"],
rules: {
"jsdoc/require-property": "error",
},
});bash
oxlint --deny jsdoc/require-property --jsdoc-plugin版本
此规则自 v0.2.18 起加入。