JSDoc Writing Guide

Quick Start

All exported functions require 4 mandatory tags:

/**
 * @description One-line summary.
 * @param {Type} name - Description.
 * @returns {Type} Description.
 * @example
 * const result = useHook(input);
 */

Core Patterns

1. @description - First line is a one-sentence summary