Ensures that parameter names in JSDoc match those in the function declaration.
Note that by default the rule will not report parameters present on the docs but non-existing on the function signature when an object rest property is part of that function signature since the seemingly non-existing properties might actually be a part of the object rest property.
/**
* @param options
* @param options.foo
*/
function quux ({foo, ...extra}) {}To require that extra be documented--and that any extraneous properties
get reported--e.g., if there had been a @param options.bar above--you
can use the checkRestProperty option which insists that the rest
property be documented (and that there be no other implicit properties).
Note, however, that jsdoc does not appear
to currently support syntax or output to distinguish rest properties from
other properties, so in looking at the docs alone without looking at the
function signature, the disadvantage of enabling this option is that it
may appear that there is an actual property named extra.
See the "Destructuring" section. Defaults to false.
See require-param under the option of the same name.
Set to true to auto-remove @param duplicates (based on identical
names).
Note that this option will remove duplicates of the same name even if the definitions do not match in other ways (e.g., the second param will be removed even if it has a different type or description).
If set to true, this option will allow extra @param definitions (e.g.,
representing future expected or virtual params) to be present without needing
their presence within the function signature. Other inconsistencies between
@param's and present function parameters will still be reported.
Whether to check destructured properties. Defaults to true.
| Context | ArrowFunctionExpression, FunctionDeclaration, FunctionExpression |
| Options | allowExtraTrailingParamDocs, checkDestructured, checkRestProperty, checkTypesPattern |
| Tags | param |