jsdoc/require-param-description 細かい

An auto-fix is available for this rule.

各 @param タグに説明文が存在することを要求します。

パラメータの説明はドキュメント化されるべきです。

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

javascript

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

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

javascript

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

使い方

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

Config (.oxlintrc.json)CLI

json

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

bash

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