Skip to content
← Back to rules

jsdoc/require-param-type 慎重なチェック

An auto-fix is available for this rule.

何をするか

@param タグがカッコ内に型の値を含むことを要求します。

なぜ悪いのか

パラメータの型は文書化すべきです。

このルールに対する不正なコードの例:

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

このルールに対する正しいコードの例:

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

使用方法

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

json
{
  "plugins": ["jsdoc"],
  "rules": {
    "jsdoc/require-param-type": "error"
  }
}
bash
oxlint --deny jsdoc/require-param-type --jsdoc-plugin

参照