Jsdoc Typescript Docs

Good JSDoc hygiene is one of those things you know you should do but never quite get around to standardizing. This skill handles the boilerplate: documenting functions with proper param and return tags, adding examples to interfaces and classes, covering async functions with throws annotations, and even dealing with generics and overloads correctly. The patterns here are solid, including the Result type pattern and the factory method documentation. Useful if you're setting up TypeDoc generation or just want your team to stop writing three word comments above complex functions.

skills.sh installs: 564
GitHub stars: 63
last updated: Aug 21, 2026

View on GitHub

Install

$ npx -y skills add patricio0312rev/skills --skill jsdoc-typescript-docs --agent claude-code

Installs into .claude/skills of the current project.

Files

JSDoc TypeScript Documentation

Create comprehensive inline documentation for TypeScript codebases.

Core Workflow

Document functions: Parameters, returns, examples
Document types: Interfaces, types, enums
Add descriptions: Purpose and usage
Include examples: Code samples
Generate docs: TypeDoc output
Integrate CI: Automated doc generation

Function Documentation

Basic Function

/**
 * Calculates the total price including tax.
 *
 * @param price - The base price before tax
 * @param taxRate - The tax rate as a decimal (e.g., 0.08 for 8%)
 * @returns The total price including tax
 *
 * @example
 * ```typescript
 * const total = calculateTotal(100, 0.08);
 * console.log(total); // 108
 * ```
 */
export function calculateTotal(price: number, taxRate: number): number {
  return price * (1 + taxRate);
}