← Back to rules

jsdoc/check-property-names 정확성

An auto-fix is available for this rule.

동작 방식

같은 블록 내에서 JSDoc의 속성 이름이 중복되지 않도록 보장하며, 중첩된 속성은 정의된 루트를 가져야 한다고 확인합니다.

왜 좋지 않은가?

동일한 이름을 가진 @property 태그는 혼란을 야기할 수 있으며, 오류를 시사할 수 있습니다.

예시

이 규칙에 대해 잘못된 코드 예시:

/**
 * @typedef {object} state
 * @property {number} foo
 * @property {string} foo
 */

/**
 * @typedef {object} state
 * @property {number} foo.bar
 */

이 규칙에 대해 올바른 코드 예시:

/**
 * @typedef {object} state
 * @property {number} foo
 */

/**
 * @typedef {object} state
 * @property {object} foo
 * @property {number} foo.bar
 */

사용 방법

이 규칙을 설정 파일이나 명령줄 인터페이스를 통해 활성화하려면 다음을 사용하세요:

설정 파일 (.oxlintrc.json)

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

CLI

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

참고 자료

• 규칙 소스