Agentic JSDoc Patterns
Provide JSDoc conventions that improve LLM comprehension for code generation, documentation, and RAG retrieval.
Core Principles
- TypeScript-flavor JSDoc — even in plain JS files
- Hierarchical structure — Summary → @remarks (Description) → Tags → Example
- Semantic richness — every tag carries a description, not just a type.
- Markdown formatting — use markdown backticks for
variables,types, andfunctionNameswithin descriptions to impro
[Description truncada. Veja o README completo no GitHub.]