← Back to rules

jsdoc/require-param-name 細かい

何をしますか

すべての @param タグに名前が存在することを要求します。

なぜ問題なのか

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

例

このルールに違反するコードの例:

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

このルールに準拠するコードの例:

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

使用方法

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

Config (.oxlintrc.json)

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

CLI

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

参照

• ルールのソース