Mismatched JSDoc and function signature

Last modified: 03 December 2024

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 Details

By default bundled with:

CLion 2024.3, GoLand 2024.3, IntelliJ IDEA 2024.3, JetBrains Rider 2024.3, PhpStorm 2024.3, PyCharm 2024.3, Qodana for .NET 2024.3, Qodana for Go 2024.3, Qodana for JS 2024.3, Qodana for JVM 2024.3, Qodana for PHP 2024.3, Qodana for Ruby 2024.3, RubyMine 2024.3, WebStorm 2024.3

Can be installed with plugin:

JavaScript and TypeScript, 243.23139