← Back to rules

jsdoc/require-property-description 정확성

작동 방식

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

왜 문제가 되는가?

속성의 설명은 문서화되어야 합니다.

예시

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

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

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

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

사용 방법

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

구성 파일 (.oxlintrc.json)

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

CLI

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

참고 자료

• 규칙 소스