typescript-jsdoc

Generate JSDoc comments for TypeScript public APIs and classes.

Updated Aug 27, 2026

Search Tags:#typescript #documentation #commenting #jsdoc #best-practices #IDE-support

Ready to run

npx skills add https://github.com/AdamManuel-dev/claude-code-ext --skill typescript-jsdoc

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams write clear, maintainable JSDoc comments for TypeScript projects, reducing confusion and improving IDE support.

Core Features & Use Cases

Guidance on JSDoc structure and essential tags to document public APIs.
Strategic documentation levels: Essential, Clarifying, and Minimal to balance effort and value.
Practical examples showing how to document functions, classes, and interfaces for better readability and IDE hints.

Quick Start

Provide a TypeScript file and ask the AI to generate JSDoc comments for all public functions.

Frequently Asked Questions about typescript-jsdoc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I write effective JSDoc comments for TypeScript code?▼

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.

What should I document in TypeScript JSDoc—everything or just key parts?▼

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.

Can I use JSDoc to improve IDE autocomplete and hints in TypeScript?▼

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.

What JSDoc tags are essential for documenting TypeScript functions and classes?▼

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.

How do I document complex TypeScript algorithms and interfaces with JSDoc?▼

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.