jsdoc-specialist

What problem does it solve?

The JSDoc Specialist removes inconsistent, missing, or low-quality JSDoc comments in JavaScript and TypeScript code so that functions and class methods are well-documented, easier to understand, and maintain.

Core Features & Use Cases

• Generate and standardize JSDoc for functions and object/class methods across JS/TS projects.
• Enforce rules: document all parameters and return values, always include @returns for async functions, add @example for pure functions, and avoid annotating variables unless explicitly requested.
• Use cases include filling missing comments for new functions, normalizing comment style during code review, and improving documentation quality for library APIs.

Quick Start

Use the jsdoc-specialist to add or normalize JSDoc comments for the functions in the file src/utils/math.ts.