tsdoc-comments

SKILL.md

TSDoc is the standard for documenting TypeScript code. It extends JSDoc with TypeScript-specific features like generic type parameters (@template). Good documentation explains not just what code does, but why, and helps users understand your API through IDE tooltips and generated docs.

Well-documented code reduces support burden and improves developer experience for your API consumers.

Document public APIs with TSDoc. Explain what, why, and provide examples. Use @template for generic type parameters.

À utiliser lors de la documentation des API publiques. À utiliser lors de l'écriture du code de la bibliothèque. À utiliser lors de l'utilisation de commentaires de style JSDoc. À utiliser lors de la génération de la documentation. À utiliser pour expliquer des types complexes. Source : marius-townhouse/effective-typescript-skills.

Voir l'original