← Back to rules

jsdoc/require-returns-description Pedantic

작동 방식

@returns 태그가 설명 값을 가져야 함을 요구합니다. 반환 값이 void 또는 undefined이거나, Promise<void> 또는 Promise<undefined>인 경우 오류는 보고되지 않습니다.

왜 문제가 되는가?

@returns 태그는 설명 값을 가져야 합니다.

예시

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

/** @returns */
function quux(foo) {}

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

/** @returns Foo. */
function quux(foo) {}

사용 방법

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

Config (.oxlintrc.json)

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

CLI

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

참고 자료

• 규칙 소스