jsdoc

Document inline TypeScript code with concise JSDoc comments.

9|Updated Dec 20, 2025

Search Tags:#typescript #documentation #commenting #jsdoc #best-practices #coding-standards #inline-docs

Ready to run

npx skills add https://github.com/christopher-buss/flux --skill jsdoc-christopher-buss

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: jsdoc
Source: https://github.com/christopher-buss/flux/tree/main/.agents/skills/jsdoc
Command: npx skills add https://github.com/christopher-buss/flux --skill jsdoc-christopher-buss

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill provides guidelines for writing minimal, high-quality JSDoc comments in TypeScript codebases to improve clarity and maintainability.

Core Features & Use Cases

Standardizes tag usage: @default, @example, @note, @deprecated, @param, @returns to describe behavior and usage.
Emphasizes describing what code does rather than duplicating TypeScript types, and provides patterns for properties, enums, and functions.
Use cases include documenting configuration options, APIs, and inline documentation for generated docs to assist maintainers and users.

Quick Start

Annotate public APIs with concise, behavior-focused JSDoc using the recommended tags in the stated order.

Frequently Asked Questions about jsdoc

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

FAQPage Schema

What is the best way to write JSDoc comments in TypeScript without duplicating type definitions?▼

To document TypeScript code with JSDoc, annotate public APIs, interfaces, and functions with concise comments. Apply recommended tags in a specified order to ensure consistent, behavior-focused inline documentation across the codebase.

Which JSDoc tags should I use for documenting TypeScript functions and enums?▼

When documenting TypeScript APIs with JSDoc, emphasize describing what the code does rather than duplicating TypeScript types. This approach provides clear patterns for properties, enums, and functions without redundant type information.

How do I standardize inline documentation patterns for TypeScript APIs?▼

JSDoc guidelines for TypeScript apply to projects seeking consistent inline documentation for interfaces, functions, and APIs. They suit codebases documenting configuration options and APIs to assist maintainers and users of generated docs.

Do I need JSDoc comments if my TypeScript project already has strict type definitions?▼

Downstream actions for JSDoc comments include generating external API documentation and providing inline context for maintainers. Standardized tags like @example and @deprecated structure the output for generated docs and usage guides.