Global Commenting

JSDoc comments document component props using @param or @prop tags with type and description. This approach clarifies what each prop does and its expected type, making components easier to use and maintain without over-commenting obvious code.

Comment on the 'why' behind technical decisions: complex algorithms, performance optimizations, browser compatibility workarounds, and non-obvious implementations. Skip obvious code like simple assignments or straightforward loops to avoid redundancy.

Use JSDoc comments on API route handlers to specify request parameters, response formats, and status codes. This creates clear contracts for API consumers and improves maintainability by documenting expected data structures.

Yes, JSDoc comments work for configuration schemas and regex patterns. Explain what each configuration option does, constraints, and what regex patterns match, helping future maintainers understand purpose without guessing intent.

Meaningful documentation explains the reasoning and context behind decisions; over-commenting restates what code obviously does. JSDoc-based comments focus on non-obvious logic, technical trade-offs, and 'why' decisions were made this way.

Keep comments focused on current functionality and reasoning, not past changes. Use version control and commit messages for change history; comments should explain the present design, not chronicle evolution.