← Back to rules

jsdoc/require-property-name 정확성

동작 방식

모든 @property 태그에 이름이 있어야 함을 요구합니다.

왜 문제가 되는가?

속성의 타입 이름은 문서화되어야 합니다.

예시

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

/**
 * @typedef {SomeType} SomeTypedef
 * @property {number}
 */

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

/**
 * @typedef {SomeType} SomeTypedef
 * @property {number} foo
 */

사용 방법

설정 파일 또는 명령줄 인터페이스에서 이 규칙을 활성화하려면 다음을 사용할 수 있습니다:

Config (.oxlintrc.json)

{
  "plugins": ["jsdoc"],
  "rules": {
    "jsdoc/require-property-name": "error"
  }
}

CLI

oxlint --deny jsdoc/require-property-name --jsdoc-plugin

참고 자료

• 규칙 소스