-
-
Notifications
You must be signed in to change notification settings - Fork 167
Closed
Description
Motivation
Often many parameters are self-explanatory, but some aren't. It would be great if jsdoc/check-param-names
had an option to skip the missing
Current behavior
/**
* @param additionalChecks If true, it is checked if the argument is within the bounds 0<x<100
*/
function add10(target: number, additionalChecks: boolean) {
Error:
Expected @param names to be "target, additionalChecks". Got "additionalChecks".
Desired behavior
Some parameters are self-explanatory. Adding a comment about them just increases noise and reduces readability. I understand if the default should stay as is but a config option like "jsdoc/check-param-names":["warn",{ disableMissingParamChecks: true}]
would be great.
Alternatives considered
The only option I saw is disabling the rule completely - but that would also remove the checks for whether the param names are correct which I like.
JoshuaKGoldberg