jsdoc/require-param-description 철저한

An auto-fix is available for this rule.

각 @param 태그에 설명 값이 반드시 포함되어야 함을 요구합니다.

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

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

javascript

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

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

javascript

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

사용 방법

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

구성 파일 (.oxlintrc.json)CLI

json

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

bash

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