← Back to rules

jsdoc/require-yields 정확성

동작 방식

@yields 주석이 문서화되어야 함을 요구합니다.
여러 개의 @yields 태그가 존재할 경우에도 경고를 보고합니다.

왜 좋지 않은가?

이 규칙은 필수적인 경우에 @yields 태그가 누락되는 것을 방지하기 위한 것입니다.

예시

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

function* quux(foo) {
  yield foo;
}

/**
 * @yields {undefined}
 * @yields {void}
 */
function* quux(foo) {}

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

/** * @yields Foo */
function* quux(foo) {
  yield foo;
}

구성

이 규칙은 다음 속성을 가진 구성 객체를 수용합니다.

###_exemptedBy

type: string[]

기본값: ["inheritdoc"]

이 태그가 포함된 함수는 린트 규칙에서 제외됩니다.

forceRequireYields

type: boolean

기본값: false

true로 설정 시, 모든 제너레이터 함수는 값이 반환되지 않거나 본문이 비어 있더라도 @yields 태그를 가져야 합니다.

withGeneratorTag

type: boolean

기본값: false

true로 설정 시, @generator 태그가 존재할 때 @yields 태그를 요구합니다.

사용 방법

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

구성 파일 (.oxlintrc.json)

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

CLI

oxlint --deny jsdoc/require-yields --jsdoc-plugin

참고 자료

• 규칙 소스