jsdoc/require-param-description 严谨

An auto-fix is available for this rule.

要求每个 @param 标签都必须有描述内容。

参数的描述应当被记录。

此规则的错误代码示例：

javascript

/** @param foo */
function quux(foo) {}

此规则的正确代码示例：

javascript

/** @param foo Foo. */
function quux(foo) {}

如何使用

通过配置文件或在 CLI 中启用此规则，可以使用以下方式：

配置文件 (.oxlintrc.json)CLI

json

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

bash

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