← Back to rules

jsdoc/check-access 제한

동작 방식

@access 태그가 다음 값 중 하나를 사용하는지 확인합니다:

• "package", "private", "protected", "public"

또한 다음과 같은 사항을 보고합니다:

• 동일한 문서 블록 내에서 @access와 @public, @private, @protected, 또는 @package를 함께 사용하는 경우.
• 동일한 문서 블록 내에서 @access (또는 @public 등) 태그를 여러 번 사용하는 경우.

왜 문제가 될까?

JSDoc 주석에서 접근 수준을 일관된 방식으로 지정하는 것이 중요합니다.
잘못된 또는 중복된 접근 수준 태그를 사용하면 문서화된 요소의 의도된 가시성에 대한 혼란을 초래하고,
API 문서 생성 시 일관성 문제를 유발할 수 있습니다.
다양한 접근 태그를 섞어 쓰거나 잘못된 값을 사용하면 문서가 명확하지 않고 오해의 소지가 생길 수 있습니다.

예시

이 규칙에 적절하지 않은 코드 예시:

/** @access private @public */

/** @access invalidlevel */

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

/** @access private */

/** @private */

사용 방법

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

구성 파일 (.oxlintrc.json)

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

CLI

oxlint --deny jsdoc/check-access --jsdoc-plugin

참고 자료

• 규칙 소스