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.
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 | |
|---|---|
Available in: | AppCode 2023.3, CLion 2023.3, GoLand 2023.3, IntelliJ IDEA 2023.3, JetBrains Rider 2023.1, PhpStorm 2023.3, PyCharm 2023.3, Qodana for .NET 2023.1, Qodana for JS 2023.3, Qodana for JVM 2023.3, Qodana for PHP 2023.3, Qodana for Ruby 2023.3, RubyMine 2023.3, WebStorm 2023.3 |
Plugin: | JavaScript and TypeScript, 233.SNAPSHOT |
Last modified: 13 July 2023