← Back to rules

jsdoc/require-returns 严格检查

An auto-fix is available for this rule.

功能说明

要求对返回语句进行文档注释。 如果存在多个 @returns 标签，也会发出警告。

为什么这是问题？

该规则旨在防止在必要时遗漏 @returns 标签。

示例

以下为 错误 的代码示例：

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

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

以下为 正确 的代码示例：

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

配置

此规则接受一个包含以下属性的配置对象：

checkConstructors

type: boolean

默认值: false

是否检查构造函数方法。

checkGetters

type: boolean

默认值: true

是否检查获取器方法。

exemptedBy

type: string[]

默认值: ["inheritdoc"]

免除函数必须添加 @returns 标签的标签列表。

forceRequireReturn

type: boolean

默认值: false

即使函数不返回任何值，也强制要求添加 @returns 标签。

forceReturnsWithAsync

type: boolean

默认值: false

是否强制异步函数必须添加 @returns 标签。

使用方法

要通过配置文件或 CLI 启用 此规则，可以使用：

配置文件 (.oxlintrc.json)

{
  "plugins": ["jsdoc"],
  "rules": {
    "jsdoc/require-returns": "error"
  }
}

CLI

oxlint --deny jsdoc/require-returns --jsdoc-plugin

参考资料

• 规则源码