jsdoc/check-tag-names Correctness

✅ This rule is turned on by default.

Reports invalid block tag names. Additionally checks for tag names that are redundant when using a type checker such as TypeScript.

Using invalid tags can lead to confusion and make the documentation harder to read.

Examples of incorrect code for this rule:

javascript

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

/**
 * This is redundant when typed.
 * @type {string}
 */

Examples of correct code for this rule:

javascript

/** @param */

How to use

To enable this rule in the CLI or using the config file, you can use:

CLIConfig (.oxlintrc.json)

bash

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

json

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