jsdoc
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.
How do I install this agent skill?
npx skills add https://github.com/enderpuentes/ai-agent-skills --skill jsdocIs this agent skill safe to install?
- Gen Agent Trust Hubpass
This skill provides instructions, best practices, and examples for writing JSDoc comments in JavaScript and TypeScript. It includes guidance on using the JSDoc CLI to generate documentation and links to the official JSDoc website.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
What does this agent skill do?
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
@todofor 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
@paramentries 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
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/enderpuentes/ai-agent-skills/jsdoc">View jsdoc on skillZs</a>