跳到内容

jsdoc/require-returns 佶屈聱牙

它做什么

要求对返回语句进行记录。当同时存在多个 @returns 标记时,也将进行报告。

为什么这样做不好?

此规则旨在防止在必要时遗漏 @returns 标记。

示例

以下是不对此规则进行正确编码示例

javascript
/** Foo. */
function quux() {
  return foo;
}

/**
 * @returns Foo!
 * @returns Foo?
 */
function quux() {
  return foo;
}

以下是对此规则进行正确编码示例

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

参考

根据 MIT 许可发布。