jsdoc-specialist

Generate and standardize JSDoc comments for JavaScript and TypeScript functions and methods.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/linzb93/cli-tools --skill jsdoc-specialist
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: jsdoc-specialist
Source: https://github.com/linzb93/cli-tools/tree/main/.trae/skills/jsdoc-specialist
Command: npx skills add https://github.com/linzb93/cli-tools --skill jsdoc-specialist

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The JSDoc Specialist removes inconsistent, missing, or low-quality JSDoc comments in JavaScript and TypeScript code so that functions and class methods are well-documented, easier to understand, and maintain.

Core Features & Use Cases

  • Generate and standardize JSDoc for functions and object/class methods across JS/TS projects.
  • Enforce rules: document all parameters and return values, always include @returns for async functions, add @example for pure functions, and avoid annotating variables unless explicitly requested.
  • Use cases include filling missing comments for new functions, normalizing comment style during code review, and improving documentation quality for library APIs.

Quick Start

Use the jsdoc-specialist to add or normalize JSDoc comments for the functions in the file src/utils/math.ts.

Frequently Asked Questions about jsdoc-specialist

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

FAQPage Schema
How do I generate JSDoc comments for JavaScript and TypeScript functions?

To generate JSDoc comments for JavaScript and TypeScript functions, apply this Skill to your codebase to automatically document all parameters, return values, and async Promise types while preserving your existing project style.

What is the best way to standardize inconsistent JSDoc comments across a codebase?

Standardizing JSDoc comments involves enforcing consistent rules across your project, such as documenting all parameters and return values, and adding @example blocks for pure functions to improve overall code maintainability and readability.

Does JSDoc generation work with TypeScript class methods and async functions?

JSDoc generation works with TypeScript class methods and async functions by explicitly documenting their returns as Promise types and ensuring every parameter is described with appropriate types, effectively covering object-oriented code structures.

Can I use this to add @example tags automatically for pure functions?

You can use this to add @example tags automatically for pure functions during documentation tasks, ensuring reusable code blocks have clear usage examples without manually writing boilerplate comments for every utility method.

When should I avoid automatic JSDoc generation for variables?

You should avoid automatic JSDoc generation for variables unless explicitly requested, as the standardization process specifically targets functions and class methods to ensure API documentation remains focused rather than cluttering variable declarations.