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.

Úselo al documentar API públicas. Úselo al escribir código de biblioteca. Utilícelo cuando utilice comentarios de estilo JSDoc. Úselo al generar documentación. Úselo al explicar tipos complejos. Fuente: marius-townhouse/effective-typescript-skills.

Ver original