tsdoc-comments

Document TypeScript and JavaScript code with TSDoc-compliant comments.

Updated Jan 18, 2026

Search Tags:#typescript #documentation #jsdoc #code-comments #tsdoc #tsdoc-comments

Ready to run

npx skills add https://github.com/333-333-333/iris --skill tsdoc-comments

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: tsdoc-comments
Source: https://github.com/333-333-333/iris/tree/main/skills/tsdoc-comments
Command: npx skills add https://github.com/333-333-333/iris --skill tsdoc-comments

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes assets (resource) components.

What problem does it solve?

Consistent, well-structured documentation for TypeScript/JavaScript APIs is often missing or inconsistent, making it hard to understand public interfaces.

Core Features & Use Cases

Enforces TSDoc-compliant tags for functions, classes, and interfaces
Provides examples for @param, @returns, @throws, @remarks, and @example
Supports both TypeScript and JavaScript projects and can integrate with tooling like ESLint-plugin-tsdoc
Includes templates and best-practice guidance to speed up documentation workflows

Quick Start

Document a new function with a concise TSDoc comment covering parameters, return value, and usage.

Frequently Asked Questions about tsdoc-comments

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

FAQPage Schema

How do I generate TSDoc comments for TypeScript functions and classes?▼

To generate TSDoc comments, apply TSDoc-compliant tags to public APIs, classes, and functions. This enforces structured parameter and return documentation, improving API readability and consistency across TypeScript and JavaScript projects.

What is the best way to enforce consistent TypeScript documentation across a team?▼

Enforcing consistent TypeScript documentation requires applying TSDoc-compliant tags and style guidelines. Using structured templates for parameters and returns ensures automated documentation generation maintains uniform API clarity across the team.

Can I use TSDoc comments for JavaScript projects or is it only for TypeScript?▼

Yes, TSDoc comments can be used for JavaScript projects. The documentation style applies to both TypeScript and JavaScript, enforcing structured tags for public APIs, functions, and classes to improve overall code readability.

Does TSDoc work with ESLint to validate code comments?▼

Yes, TSDoc integrates with tooling like ESLint-plugin-tsdoc. This integration enforces TSDoc-compliant tags and style guidelines, validating structured parameter and return documentation directly during the development workflow.

What TSDoc tags should I include for public API documentation?▼

Public API documentation should include TSDoc tags like @param, @returns, @throws, @remarks, and @example. These structured tags provide standardized parameter, return value, and usage details for automated documentation generation.

Why should I use TSDoc instead of standard JSDoc comments?▼

TSDoc standardizes documentation specifically for TypeScript APIs, enforcing structured tags that support type information. It provides consistent templates for parameters and returns, ensuring better automated documentation generation than standard JSDoc patterns.