Skip to content
← Back to rules

jsdoc/no-defaults 正确性

An auto-fix is available for this rule.

它的作用

此规则报告在 @param@default 的相关部分中使用默认值的情况。
它还可选择性地报告所有 @param 标签中是否存在方括号表示的可选参数。

为什么这是不好的?

该规则旨在防止在标签中注明默认值,因为这与 ES2015 的默认参数语法重复,属于冗余信息。

示例

此规则的错误代码示例:

javascript
/** @param {number} [foo="7"] */
function quux(foo) {}

此规则的正确代码示例:

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

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

配置

此规则接受一个配置对象,包含以下属性:

noOptionalParamNames

type: boolean

default: false

如果为 true,则报告 @param 标签中存在可选参数名(方括号)的情况。

如何使用

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

json
{
  "plugins": ["jsdoc"],
  "rules": {
    "jsdoc/no-defaults": "error"
  }
}
bash
oxlint --deny jsdoc/no-defaults --jsdoc-plugin

参考资料