Skip to content
← Back to rules

jsdoc/require-param-name 严谨

An auto-fix is available for this rule.

它做了什么

要求所有 @param 标签都必须包含名称。

为什么这是不好的?

参数的名称应当被记录下来。

示例

此规则的 错误 代码示例:

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

此规则的 正确 代码示例:

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

如何使用

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

json
{
  "plugins": ["jsdoc"],
  "rules": {
    "jsdoc/require-param-name": "error"
  }
}
bash
oxlint --deny jsdoc/require-param-name --jsdoc-plugin

参考资料