← Back to rules

jsdoc/check-tag-names 正しさ

An auto-fix is available for this rule.

何を実行するか

無効なブロックタグ名を報告します。 さらに、型チェックツール（例：TypeScript）を使用している場合に重複するタグ名の検証も行います。

なぜ悪いのか

無効なタグを使用すると、混乱を招き、ドキュメントの読みやすさが低下する可能性があります。

例

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

/** @Param */
/** @foo */

/**
 * 型指定がある場合、これは冗長です。
 * @type {string}
 */

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

/** @param */

設定

許可されるタグの設定は settings.jsdoc.tagNamePreference を通じて行います。 このルール用の CLI 専用パラメータは存在しません。

カスタムタグを追加するには、追加したいタグ名と一致するキーと値のペアを追加してください。以下の通りです：

Config (.oxlintrc.json)

{
  "plugins": ["jsdoc"],
  "rules": {
    "jsdoc/check-tag-names": "error"
  },
  "settings": {
    "jsdoc": {
      "tagNamePreference": {
        "customTagName": "customTagName"
      }
    }
  }
}

上記の設定を使用した場合、customTagName タグを追加したときの正しいコードの例：

/**
 * @customTagName
 */

設定

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

definedTags

型: string[]

デフォルト: []

追加で許可するタグ名。

jsxTags

型: boolean

デフォルト: false

以下の JSX 関連のタグを許可するかどうか：

• jsx
• jsxFrag
• jsxImportSource
• jsxRuntime

typed

型: boolean

デフォルト: false

typed が true の場合、TypeScript の機能と重複する・不要なタグを禁止します。

使用方法

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

Config (.oxlintrc.json)

{
  "plugins": ["jsdoc"],
  "rules": {
    "jsdoc/check-tag-names": "error"
  }
}

CLI

oxlint --deny jsdoc/check-tag-names --jsdoc-plugin

参照

• ルールのソース