← Back to rules

jsdoc/require-returns Pedantic

🚧 An auto-fix is planned for this rule, but not implemented at this time.

작동 방식

반환문이 문서화되어야 한다고 요구합니다.
여러 개의 @returns 태그가 포함된 경우에도 경고를 보고합니다.

왜 문제가 되는가?

이 규칙은 필요할 때 @returns 태그를 누락시키는 것을 방지하기 위해 의도되었습니다.

예시

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

/** Foo. */
function quux() {
  return foo;
}

/**
 * @returns Foo!
 * @returns Foo?
 */
function quux() {
  return foo;
}

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

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

구성

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

checkConstructors

type: boolean

기본값: false

생성자 메서드를 검사할지 여부.

checkGetters

type: boolean

기본값: true

getter 메서드를 검사할지 여부.

exemptedBy

type: string[]

기본값: ["inheritdoc"]

@returns 태그가 필요하지 않도록 하는 태그들.

forceRequireReturn

type: boolean

기본값: false

함수에서 값을 반환하지 않더라도 @returns 태그를 요구할지 여부.

forceReturnsWithAsync

type: boolean

기본값: false

비동기 함수에 대해서도 @returns 태그를 요구할지 여부.

사용 방법

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

Config (.oxlintrc.json)

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

CLI

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

참고 자료

• 규칙 소스