Skip to content
← Back to rules

jsdoc/require-param-type 严格检查

An auto-fix is available for this rule.

它做了什么

要求每个 @param 标签都必须包含类型值(用大括号括起来)。

为什么这是个问题?

参数的类型应当被记录。

示例

此规则的错误代码示例:

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

此规则的正确代码示例:

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

如何使用

要通过配置文件或 CLI 启用此规则,可以使用:

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

参考资料