跳至内容

jsdoc/require-param-description 吹毛求疵

作用

要求每个 @param 标签都有一个描述值。

为什么这么糟糕?

param 的描述应该有文档说明。

示例

此规则的不正确代码示例

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

此规则的正确代码示例

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

参考

根据 MIT 许可证发布。