跳到正文

jsdoc/require-param 繁琐

它的作用

要求所有函数参数都用 JSDoc @param 标记进行记录。

为什么这是错误的?

此规则旨在通过要求记录所有函数参数来强化代码质量和可维护性。

示例

此规则的不正确代码示例

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

此规则的正确代码示例

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

参考

在 MIT 许可下发布。