Code Inspection: Mismatched JSDoc and function signature
Configure inspections: Settings | Editor | Inspections
Show intention actions: AltEnter
Reports mismatch between the names and the number of parameters within a JSDoc comment and the actual parameters of a function. Suggests updating parameters in JSDoc comment.
Example:
/**
* @param height Height in pixels
*/
function sq(height, width) {} // width is not documented
After the quick-fix is applied:
/**
* @param height Height in pixels
* @param width
*/
function sq(height, width) {}
Place the caret at the highlighted line and press AltEnter or click
.
Click the arrow next to the inspection you want to suppress and select the necessary suppress action.