jsdoc/require-param Pedantic

Requires that all function parameters are documented with JSDoc @param tags.

The rule is aimed at enforcing code quality and maintainability by requiring that all function parameters are documented.

Examples of incorrect code for this rule:

javascript

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

Examples of correct code for this rule:

javascript

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

How to use

To enable this rule in the CLI or using the config file, you can use:

CLIConfig (.oxlintrc.json)

bash

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

json

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