← Back to rules

jsdoc/no-defaults 정확성

An auto-fix is available for this rule.

작동 방식

이 규칙은 @param 또는 @default의 관련 부분에서 기본값이 사용되고 있는 경우 경고를 보고합니다. 또한 선택적으로 대괄호로 둘러싸인 선택적 인자(옵셔널 매개변수)의 존재 여부도 보고할 수 있습니다.

왜 문제일까?

이 규칙은 ES2015의 기본 매개변수와 중복되는, 태그 내에서 기본값을 표시하는 것을 방지하기 위해 의도된 것입니다.

예시

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

/** @param {number} [foo="7"] */
function quux(foo) {}

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

/** @param {number} foo */
function quux(foo) {}

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

구성

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

noOptionalParamNames

type: boolean

기본값: false

true로 설정되면 @param 태그에서 선택적 매개변수 이름(대괄호 포함)의 존재 여부를 보고합니다.

사용 방법

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

구성 파일 (.oxlintrc.json)

{
  "plugins": ["jsdoc"],
  "rules": {
    "jsdoc/no-defaults": "error"
  }
}

CLI

oxlint --deny jsdoc/no-defaults --jsdoc-plugin

참고 자료

• 규칙 소스