jsdoc/no-defaults 正しさ

An auto-fix is available for this rule.

このルールは、@param タグまたは @default タグの関連部分にデフォルト値が使用されている場合に警告を出力します。また、オプション引数（角括弧で囲まれたもの）が存在する場合についても、任意で警告を出力します。

このルールは、ES2015 のデフォルトパラメータと重複する情報としてデフォルト値をタグに記述することを防ぐことを目的としています。

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

javascript

/** @param {number} [foo="7"] */
function quux(foo) {}

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

javascript

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

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

設定

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

型: boolean

デフォルト: false

true にすると、@param タグにオプションのパラメータ名（角括弧で囲まれたもの）が含まれている場合に警告を出力します。

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

設定ファイル (.oxlintrc.json)CLI

json

{
  "plugins": ["jsdoc"],
  "rules": {
    "jsdoc/no-defaults": "error"
  }
}

bash

oxlint --deny jsdoc/no-defaults --jsdoc-plugin