jsdoc

Q: How do I install jsdoc?

Run npx skills add https://github.com/enderpuentes/ai-agent-skills --skill jsdoc in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/jsdoc/ (personal) or .claude/skills/jsdoc/ (project).

by enderpuentesAI & Agents

Write and maintain JSDoc comments for JavaScript and TypeScript APIs: functions, classes, modules, parameters, returns, examples, and TODO annotations. Use when documenting code, generating API docs, setting JSDoc conventions, or when the user mentions JSDoc tags like @param, @returns, or @todo.

Installs: 46
Last 24h: —
Trending rank: —
Security: Not audited

Install

Works with every agent the skills CLI supports.

npx skills add https://github.com/enderpuentes/ai-agent-skills --skill jsdoc

01
Install
Run the command in your project. The CLI asks which agents to install for.
02
Describe the task
Ask your agent for something this skill covers. It loads jsdoc automatically when relevant.
03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.

SKILL.md

The instructions your agent reads when the skill is triggered.

JSDoc

Overview

JSDoc is a documentation generator for JavaScript. You write documentation comments directly above code, and JSDoc parses those comments to generate API documentation.

Core principle: Document the public API clearly and keep comments colocated with code so docs stay accurate as implementation changes.

Comment rules

JSDoc blocks must start with /** (exactly two stars after the slash).
Blocks that start with /*, /***, or more stars are ignored by the JSDoc parser.
Place the comment immediately before the symbol being documented (function, class, method, module, etc.).
Prefer documenting public and reusable APIs first.

Quick start

/**
 * Adds two numbers.
 * @param {number} a - First number.
 * @param {number} b - Second number.
 * @returns {number} Sum of the two numbers.
 */
function add(a, b) {
  return a + b;
}

Core tags

Tag	Use
`@param {Type} name - description`	Document function parameters
`@returns {Type} description`	Document return value
`@constructor`	Mark a function as a constructor
`@todo text`	Track pending tasks in docs

Use additional tags as needed for your project (@example, @throws, @deprecated, @see, etc.).

Common documentation patterns

Functions

/**
 * Formats a user's full name.
 * @param {string} firstName - User first name.
 * @param {string} lastName - User last name.
 * @returns {string} The formatted full name.
 */
function formatName(firstName, lastName) {
  return `${firstName} ${lastName}`;
}

Constructor-style functions

/**
 * Represents a book.
 * @constructor
 * @param {string} title - Book title.
 * @param {string} author - Book author.
 */
function Book(title, author) {
  this.title = title;
  this.author = author;
}

TODO annotations

/**
 * @todo Implement pagination support.
 * @todo Add validation for empty input.
 */
function listItems() {}

Generate documentation

Basic CLI usage:

jsdoc book.js

This generates HTML docs in an out/ directory by default.

You can also pass multiple source files:

/path/to/jsdoc src/a.js src/b.js

You may provide a config file for CLI options and template customization.

Best practices

Keep descriptions short, specific, and focused on behavior.
Document parameter and return types consistently.
Include @todo for known gaps that must be tracked.
Update comments whenever API signatures change.
Document exported/public modules first, then internal helpers as needed.
Keep examples executable and realistic.

Common mistakes

Using /* ... */ instead of /** ... */ for JSDoc blocks.
Writing comments far from the symbol they describe.
Missing @param entries for function inputs.
Describing implementation details instead of API behavior.
Letting comments drift from current code after refactors.

Additional resources

reference.md — Official JSDoc docs links for quick lookup.
Official docs: https://jsdoc.app

FAQ

What does the jsdoc skill do?

How do I install jsdoc?

Run npx skills add https://github.com/enderpuentes/ai-agent-skills --skill jsdoc in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/jsdoc/ (personal) or .claude/skills/jsdoc/ (project).

Which AI agents can use jsdoc?

Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.

Is jsdoc safe to install?

No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.

Who maintains jsdoc?

It is published by enderpuentes in enderpuentes/ai-agent-skills. It has 46 recorded installs.

More from enderpuentes/ai-agent-skills

View all →

pagespeed-insights

enderpuentes/ai-agent-skills

Audit web pages for performance optimization following PageSpeed Insights guidelines. Use when analyzing page performance, optimizing web applications, reviewing performance metrics, implementing Core Web Vitals improvements, or when the user mentions page speed, performance optimization, Lighthouse scores, or Core Web Vitals.

Code Quality & Workflow1.1K installs