← Back to rules

jsdoc/check-tag-names 정확성

An auto-fix is available for this rule.

동작 방식

잘못된 블록 태그 이름을 보고합니다.
또한 타입 체커(예: TypeScript)를 사용할 때 중복되는 태그 이름도 확인합니다.

왜 문제가 되는가?

잘못된 태그를 사용하면 혼란을 초래하고 문서를 읽기 어려워질 수 있습니다.

예시

이 규칙에 대한 부적절한 코드 예시:

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

/**
 * 타입 정보가 있는 경우 중복됩니다.
 * @type {string}
 */

이 규칙에 대한 적절한 코드 예시:

/** @param */

설정

허용되는 태그에 대한 구성은 settings.jsdoc.tagNamePreference를 통해 수행됩니다.
이 규칙에 대해 명령줄 전용 매개변수는 없습니다.

사용자 정의 태그를 추가하려면, 추가하려는 태그 이름과 일치하는 키-값 쌍을 추가하면 됩니다. 예시:

구성 (.oxlintrc.json)

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

위 구성에서 customTagName 태그를 추가한 경우, 다음은 적절한 코드 예시입니다:

/**
 * @customTagName
 */

구성

이 규칙은 다음과 같은 속성을 가진 구성 객체를 수락합니다.

definedTags

type: string[]

기본값: []

추가로 허용할 태그 이름 목록입니다.

jsxTags

type: boolean

기본값: false

JSX 관련 태그를 허용할지 여부:

• jsx
• jsxFrag
• jsxImportSource
• jsxRuntime

typed

type: boolean

기본값: false

typed가 true인 경우, TypeScript 기능과 중복되거나 불필요한 태그를 허용하지 않습니다.

사용 방법

이 규칙을 구성 파일 또는 명령줄을 통해 활성화하려면 다음을 사용할 수 있습니다:

구성 (.oxlintrc.json)

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

CLI

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

참고 자료

• 규칙 소스