Skip to content

Files

Latest commit

 

History

History
27 lines (21 loc) · 462 Bytes

require-param-name.md

File metadata and controls

27 lines (21 loc) · 462 Bytes

Pattern: Missing parameter name

Issue: -

Description

Each @param tag must include the parameter name that it documents. A type alone is not sufficient for proper documentation.

Examples

Example of incorrect code:

/**
 * @param {string}
 * @param {number}
 */
function updateUser(name, age) {}

Example of correct code:

/**
 * @param {string} name
 * @param {number} age
 */
function updateUser(name, age) {}