jsdoc/require-param Pedantic
它的作用
要求所有函数参数都使用 JSDoc @param 标签进行文档说明。
这为什么不好？
该规则旨在通过要求为所有函数参数编写文档来强化代码质量和可维护性。
示例
以下是此规则的错误代码示例：
javascript
/** @param foo */
function quux(foo, bar) {}以下是此规则的正确代码示例：
javascript
/** @param foo */
function quux(foo) {}配置
此规则接受一个包含以下属性的配置对象：
checkConstructors
type: boolean
default: false
是否检查构造函数方法。
checkDestructured
type: boolean
default: true
是否检查解构参数。
checkDestructuredRoots
type: boolean
default: true
是否在存在如下代码时检查解构参数： function doSomething({ a, b }) { ... }。由于在此示例中没有命名 参数，当此选项为 true 时，你必须 有一个与 {a, b} 对应的 @param 标签。
checkGetters
type: boolean
default: true
是否检查 getter 方法。
checkRestProperty
type: boolean
default: false
是否检查剩余属性。
checkSetters
type: boolean
default: true
是否检查 setter 方法。
checkTypesPattern
type: string
default: "^(?:[oO]bject|[aA]rray|PlainObject|Generic(?:Object|Array))$"
用于匹配可免于检查的类型的正则表达式模式。
exemptedBy
type: string[]
default: ["inheritdoc"]
免于 @param 检查的 JSDoc 标签列表。
如何使用
To enable this rule using the config file or in the CLI, you can use:
json
{
"plugins": ["jsdoc"],
"rules": {
"jsdoc/require-param": "error"
}
}ts
import { defineConfig } from "oxlint";
export default defineConfig({
plugins: ["jsdoc"],
rules: {
"jsdoc/require-param": "error",
},
});bash
oxlint --deny jsdoc/require-param --jsdoc-plugin版本
此规则是在 v0.4.3 中添加的。