JSDoc

What it does

Code comments

JSDoc comments begin with `/**` and can use tags to describe code such as constructors and parameters.checked 9 Oct 2026

Command line

JSDoc accepts source file paths and supports command-line options, with many options also configurable in a configuration file.checked 9 Oct 2026

Configuration

Configuration files can use JSON or, in supported versions, a CommonJS module exporting a configuration object.checked 9 Oct 2026

Customization

Users can edit the default template or create a new template for generated documentation.checked 9 Oct 2026

Documentation inputs

JSDoc can include a Markdown README in generated documentation, which the default template renders in the HTML index page.checked 9 Oct 2026

Documented code

JSDoc is intended to document APIs, including modules, namespaces, classes, methods, and method parameters.checked 9 Oct 2026

Generated output

The default template generates HTML pages in an `out/` directory unless a different destination is specified.checked 9 Oct 2026

Input file limits

By default, JSDoc processes `.js`, `.jsdoc`, and `.jsx` files and ignores files or directories whose names start with an underscore.checked 9 Oct 2026

Installation

The project README says JSDoc supports stable Node.js versions 8.15.0 and later and can be installed globally or in a project’s `node_modules` folder.checked 9 Oct 2026

Integrations

The project README lists community templates, Grunt and Gulp plugins, a GitHub Action, and a GitBook integration.checked 9 Oct 2026

License

The JSDoc generator is free software licensed under Apache License 2.0.checked 9 Oct 2026

Markdown

JSDoc provides a Markdown plugin that can be enabled through its configuration.checked 9 Oct 2026

Output location

By default, the generated documentation is saved in a directory named out, and the destination can be changed with a command-line option.checked 9 Oct 2026

Plugins

Plugins can extend JSDoc, and the configuration documentation describes built-in Markdown and summarize plugins.checked 9 Oct 2026

Purpose

JSDoc is an API documentation generator for JavaScript that scans source code comments and generates an HTML documentation website.checked 9 Oct 2026

Runtime requirement

The project README says JSDoc supports stable versions of Node.js 8.15.0 and later.checked 9 Oct 2026

Support

The project README directs users to the JSDoc Users mailing list and Stack Overflow questions tagged `jsdoc` for help.checked 9 Oct 2026

Tags

JSDoc tags add structured information to documentation comments, such as constructor and parameter details.checked 9 Oct 2026

Templates

JSDoc uses a built-in default template and allows users to edit it or create a new template.checked 9 Oct 2026

Tutorials

JSDoc allows tutorials to be included alongside API documentation.checked 9 Oct 2026