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.

Locating this inspection

By ID

Can be used to locate inspection in e.g. Qodana configuration files, where you can quickly enable or disable it, or adjust its settings.

JSCommentMatchesSignature

Via Settings dialog

Path to the inspection settings via IntelliJ Platform IDE Settings dialog, when you need to adjust inspection settings directly from your IDE.

Settings or Preferences | Editor | Inspections | JavaScript and TypeScript | General

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) {}

Inspection ID: JSCommentMatchesSignature

Suppressing Inspection

You can suppress this inspection by placing the following comment marker before the code fragment where you no longer want messages from this inspection to appear:

//noinspection JSCommentMatchesSignature

More detailed instructions as well as other ways and options that you have can be found in the product documentation:

Inspection Details
By default bundled with:	CLion 2025.2, GoLand 2025.2, IntelliJ IDEA 2025.2, JetBrains Rider 2025.2, PhpStorm 2025.2, PyCharm 2025.2, Qodana for .NET 2025.2, Qodana for Go 2025.2, Qodana for JS 2025.2, Qodana for JVM 2025.2, Qodana for PHP 2025.2, Qodana for Ruby 2025.2, RubyMine 2025.2, WebStorm 2025.2

Last modified: 18 September 2025