Document TypeScript and JavaScript code with TSDoc-compliant comments.
npx skills add https://github.com/333-333-333/iris --skill tsdoc-comments
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
Consistent, well-structured documentation for TypeScript/JavaScript APIs is often missing or inconsistent, making it hard to understand public interfaces.
Document a new function with a concise TSDoc comment covering parameters, return value, and usage.
High-intent search queries and answers about installing and using this skill.
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.
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.
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.
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.
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.
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.
youdotcom-ossGenerate and maintain TSDoc comments for TypeScript and JavaScript codebases.
barichterValidate documentation against Microsoft Style Guide and Squad-specific conventions.
icartshGenerate READMEs, changelogs, and API references from Git history.
christopher-bussDocument inline TypeScript code with concise JSDoc comments.
