The unofficial reference for JSDoc — the API documentation generator for JavaScript. Embed comments in your source code; JSDoc turns them into a complete documentation site.
Looking for the official site? Official JSDoc reference (jsdoc.app)
Place a /** */ block above any function, class, or variable. Run npx jsdoc and get a fully navigable HTML site — no configuration required to start.
/**
* Fetch a user by their numeric ID.
*
* @param {number} id - The user's ID.
* @param {RequestInit} [opts] - Optional fetch options.
* @returns {Promise<User>} Resolves with the user object.
* @throws {NotFoundError} When no user matches the ID.
*
* @example
* const user = await getUser(42);
* console.log(user.name); // "Ada Lovelace"
*/
async function getUser(id, opts) {
const res = await fetch(`/api/users/${id}`, opts);
if (!res.ok) throw new NotFoundError(id);
return res.json();
}
Generate docs with a single command:
Ship docs alongside your library. JSDoc generates a self-contained HTML site that tools like JSR, npm, and GitHub Pages can host automatically.
VS Code, WebStorm, and most modern editors read JSDoc comments directly — types, parameter descriptions, and return values appear inline as you type.
Use @param {string} and @returns {Promise<User>} to add full type information to JavaScript without a build step. TypeScript understands JSDoc types too.
Add npx jsdoc -c jsdoc.json to your CI workflow and publish fresh docs on every merge — no manual effort, always in sync with the source.