Jsdoc Typescript Docs

The jsdoc-typescript-docs skill enables AI agents to generate and manage JSDoc comments specifically tailored for TypeScript projects. It assists in creating type-safe documentation that aligns with modern JavaScript standards.

When to use it

• Generating inline documentation for new TypeScript functions or classes during code development.
• Updating outdated JSDoc blocks when refactoring existing backend logic.
• Creating comprehensive API reference guides from TypeScript source files.
• Ensuring type definitions are clearly documented for team collaboration.

Key capabilities

• Generates standard JSDoc syntax compatible with TypeScript environments.
• Supports detailed parameter and return type descriptions.
• Facilitates automated documentation extraction for backend services.

Example prompts

• "Generate JSDoc comments for this TypeScript function that calculates tax based on a user's location."
• "Update the existing JSDoc block for the UserAuth class to include new security parameters."
• "Create a complete API documentation file in JSDoc format from my TypeScript backend module."

Tips & gotchas

Ensure your project is already set up with TypeScript before using this skill, as it relies on type information to generate accurate documentation. For complex projects, provide specific context about the intended audience (e.g., internal developers vs. public API consumers) to tailor the tone and detail level of the generated docs.