← Back to rules

jsdoc/require-property-type 정확성

작동 방식

각 @property 태그가 중괄호 내에서 타입 값을 가져야 한다는 조건을 적용합니다.

왜 나쁜가?

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

예시

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

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

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

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

사용 방법

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

구성 파일 (.oxlintrc.json)

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

CLI

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

참고자료

• 규칙 소스