Generate JSDoc comments for TypeScript public APIs and classes.
npx skills add https://github.com/AdamManuel-dev/claude-code-ext --skill typescript-jsdoc
Please help me install this Agent Skill. Skill: typescript-jsdoc Source: https://github.com/AdamManuel-dev/claude-code-ext/tree/main/skills/jsdoc Command: npx skills add https://github.com/AdamManuel-dev/claude-code-ext --skill typescript-jsdoc
This Skill helps teams write clear, maintainable JSDoc comments for TypeScript projects, reducing confusion and improving IDE support.
Provide a TypeScript file and ask the AI to generate JSDoc comments for all public functions.
High-intent search queries and answers about installing and using this skill.
JSDoc comments for TypeScript begin with /** and include tags like @param, @returns, @throws, and @example to document public APIs, classes, and interfaces. Focus on clarifying intent and usage rather than duplicating type information already in your code, improving readability and IDE tooling support.
Use three strategic levels: Essential (public APIs and libraries), Clarifying (complex logic needing explanation), and Minimal (self-explanatory code). This balances documentation effort with value, keeping projects maintainable without over-documenting.
Yes. Proper JSDoc blocks with @param, @returns, and @example tags enable IDEs to display rich inline documentation, type hints, and examples when developers hover over or invoke your functions, classes, and interfaces.
Core tags include @param (parameters), @returns (return type and description), @throws (exceptions), @example (usage samples), and @deprecated (retired APIs). Use /** */ blocks to wrap these tags for full IDE and documentation tool support.
Break complex logic into clear parameter and return descriptions, use @example to show realistic usage, and add context about algorithm behavior or interface contracts. Pair with type annotations to ensure both intent and structure are explicit.
troykellyAdd JSDoc and docstrings to public functions and classes.
crmagzStandardize TypeScript inline documentation with TSDoc/JSDoc conventions.
carayaEnforce consistent TypeScript formatting with Prettier and ESLint configurations.
mgoodman60Generate structured documentation from JavaScript/TypeScript codebases using inline comments and type definitions.
