跳至内容

jsdoc/no-defaults 正确性

职责

该规则报告 @param@default 的相关部分中使用的默认值。它还可选择报告中括号中的可选参数(如果有)。

为什么它不好?

此规则旨在防止在标记中显示默认为冗余的 ES6 默认参数的情况。

示例

此规则下错误代码示例

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

此规则下正确代码示例

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

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

引用

在 MIT 许可下发布。