← 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 设置的参数。

你可以通过添加一个键值对来添加自定义标签，其中键和值都匹配你想要添加的标签名称，如下所示：

配置文件 (.oxlintrc.json)

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

在上述配置下，正确使用该规则并添加 customTagName 标签的示例代码：

/**
 * @customTagName
 */

配置

此规则接受一个包含以下属性的配置对象：

definedTags

type: string[]

default: []

额外允许的标签名称。

jsxTags

type: boolean

default: false

是否允许 JSX 相关标签：

• jsx
• jsxFrag
• jsxImportSource
• jsxRuntime

typed

type: boolean

default: false

如果 typed 为 true，则禁止那些在 TypeScript 功能中已存在或重复的标签。

如何使用

要通过配置文件或 CLI 启用此规则，可以使用：

配置文件 (.oxlintrc.json)

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

CLI

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

参考资料

• 规则源码