jsdoc/require-returns Pedantic

Requires that return statements are documented. Will also report if multiple @returns tags are present.

The rule is intended to prevent the omission of @returns tag when necessary.

Examples of incorrect code for this rule:

javascript

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

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

Examples of correct code for this rule:

javascript

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

How to use

To enable this rule in the CLI or using the config file, you can use:

CLIConfig (.oxlintrc.json)

bash

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

json

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