← Back to rules

jsdoc/require-returns-description 厳格

何をするか

@returns タグに説明文の値が必須であることを要求します。
戻り値が void または undefined である場合、または Promise<void> または Promise<undefined> である場合は、エラーは報告されません。

なぜこれは問題なのか

@returns タグには説明文の値が必要です。

例

このルールに関して 不適切な コードの例：

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

このルールに関して 適切な コードの例：

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

使用方法

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

Config (.oxlintrc.json)

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

CLI

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

参照

• ルールのソース