tsdoc-comments

What problem does it solve?

Consistent, well-structured documentation for TypeScript/JavaScript APIs is often missing or inconsistent, making it hard to understand public interfaces.

Core Features & Use Cases

• Enforces TSDoc-compliant tags for functions, classes, and interfaces
• Provides examples for @param, @returns, @throws, @remarks, and @example
• Supports both TypeScript and JavaScript projects and can integrate with tooling like ESLint-plugin-tsdoc
• Includes templates and best-practice guidance to speed up documentation workflows

Quick Start

Document a new function with a concise TSDoc comment covering parameters, return value, and usage.