Skip to content

jsdoc/require-param-name Pedantic

What it does

Requires that all @param tags have names.

Why is this bad?

The name of a param should be documented.

Examples

Examples of incorrect code for this rule:

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

Examples of correct code for this rule:

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

How to use

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

json
{
    "plugins": ["jsdoc"],
    "rules": {
        "jsdoc/require-param-name": "error"
    }
}
bash
oxlint --deny jsdoc/require-param-name --jsdoc-plugin

References

Released under the MIT License.