← Back to rules

jsdoc/require-property 정확성

An auto-fix is available for this rule.

동작 방식

@typedef 및 @namespace 태그가 평범한 object, Object, 또는 PlainObject 형식일 경우, 반드시 @property 태그를 포함하도록 요구합니다.

참고: 이 규칙은 jsdoc 설정 옵션을 통해 구성할 수 있습니다.

왜 좋지 않은가?

객체 형식에는 속성이 정의되어야 합니다.

예시

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

/**
 * @typedef {Object} SomeTypedef
 */

/**
 * @namespace {Object} SomeNamesoace
 */

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

/**
 * @typedef {Object} SomeTypedef
 * @property {SomeType} propName 속성 설명
 */

/**
 * @typedef {object} Foo
 * @property someProp
 */

사용 방법

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

구성 파일 (.oxlintrc.json)

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

CLI

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

참고 자료

• 규칙 소스