← Back to rules

jsdoc/require-returns 細部にわたる

An auto-fix is available for this rule.

何をするか

return 文がドキュメント化されていることを要求します。 複数の @returns タグが存在する場合も報告します。

なぜ問題なのか

このルールは、必要に応じて @returns タグが省略されないようにすることを目的としています。

例

このルールに対して誤りなコードの例：

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

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

このルールに対して正しいコードの例：

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

設定

このルールは、以下のプロパティを持つ設定オブジェクトを受け入れます。

checkConstructors

type: boolean

default: false

コンストラクタメソッドをチェックするかどうか。

checkGetters

type: boolean

default: true

ゲッターメソッドをチェックするかどうか。

exemptedBy

type: string[]

default: ["inheritdoc"]

@returns タグの要件から関数を除外するタグ。

forceRequireReturn

type: boolean

default: false

関数が値を返さない場合でも、@returns タグを要求するかどうか。

forceReturnsWithAsync

type: boolean

default: false

非同期関数に対しても @returns タグを要求するかどうか。

使用方法

設定ファイルまたは CLI でこのルールを有効化するには、次のように使用できます：

設定 (.oxlintrc.json)

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

CLI

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

参照

• ルールのソース