PhpStorm 2024.1 Help

Code Inspection: Mismatched JSDoc and function signature

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.


/** * @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) {}

Suppress an inspection in the editor

  1. Place the caret at the highlighted line and press Alt+Enter or click the Intention action icon.

  2. Click the arrow next to the inspection you want to suppress and select the necessary suppress action.

Last modified: 11 February 2024