Skip to content

Files

Latest commit

 

History

History
27 lines (21 loc) · 476 Bytes

require-property-name.md

File metadata and controls

27 lines (21 loc) · 476 Bytes

Pattern: Unnamed property

Issue: -

Description

Each @property tag must include the name of the property being documented. A type alone is not sufficient for proper documentation.

Examples

Example of incorrect code:

/**
 * @typedef {Object} UserConfig
 * @property {string}
 * @property {number}
 */

Example of correct code:

/**
 * @typedef {Object} UserConfig
 * @property {string} username
 * @property {number} age
 */