jsdoc/require-returns-description 冗长

其用途

要求 @returns 标签具有描述值。如果返回值为void或undefined，或者为Promise<void>或Promise<undefined>，则不会报告错误。

为什么这么糟糕？

一个 @returns 标签应该具有描述值。

示例

此规则对于不正确的代码示例

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

此规则对于正确的代码示例

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

参考

• 规则来源