← Back to rules

jsdoc/require-param-name Pedantic

작동 방식

모든 @param 태그에 이름이 필요합니다.

왜 좋지 않은가요?

매개변수의 이름은 문서화되어야 합니다.

예시

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

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

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

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

사용 방법

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

Config (.oxlintrc.json)

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

CLI

oxlint --deny jsdoc/require-param-name --jsdoc-plugin

참고자료

• 규칙 소스