typescript-tsdoc

What problem does it solve?

Prevents inconsistent or missing documentation in TypeScript code by enforcing clear, correct TSDoc usage across public APIs and important declarations.

Core Features & Use Cases

• Declaration-only documentation: Ensures TSDoc is added to exports and declarations rather than inside executable blocks.
• Consistent depth and visibility: Applies richer tags for public declarations and lighter one-liners for private/internal cases.
• Style matching: Recommends scanning existing code for current TSDoc/JSDoc patterns and aligning with them.
• Tag correctness and linking: Supports a structured tag set (including @remarks, @example, @defaultValue, and {@link}) with ordering conventions.

Quick Start

Use the typescript-tsdoc skill when editing a .ts or .tsx file to add or fix TSDoc blocks on exported/public declarations without inserting comments inside function bodies.