On the recordRead 9 Oct 202620 facts
JSDoc
On the record
- Code comments
- JSDoc comments begin with `/**` and can use tags to describe code such as constructors and parameters.jsdoc.app · read 9 Oct 2026
- Command line
- JSDoc accepts source file paths and supports command-line options, with many options also configurable in a configuration file.jsdoc.app · read 9 Oct 2026
- Configuration
- Configuration files can use JSON or, in supported versions, a CommonJS module exporting a configuration object.jsdoc.app · read 9 Oct 2026
- Customization
- Users can edit the default template or create a new template for generated documentation.jsdoc.app · read 9 Oct 2026
- Documentation inputs
- JSDoc can include a Markdown README in generated documentation, which the default template renders in the HTML index page.jsdoc.app · read 9 Oct 2026
- Documented code
- JSDoc is intended to document APIs, including modules, namespaces, classes, methods, and method parameters.jsdoc.app · read 9 Oct 2026
- Generated output
- The default template generates HTML pages in an `out/` directory unless a different destination is specified.jsdoc.app · read 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.jsdoc.app · read 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.github.com · read 9 Oct 2026
- Integrations
- The project README lists community templates, Grunt and Gulp plugins, a GitHub Action, and a GitBook integration.github.com · read 9 Oct 2026
- License
- The JSDoc generator is free software licensed under Apache License 2.0.github.com · read 9 Oct 2026
- Markdown
- JSDoc provides a Markdown plugin that can be enabled through its configuration.jsdoc.app · read 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.github.com · read 9 Oct 2026
- Plugins
- Plugins can extend JSDoc, and the configuration documentation describes built-in Markdown and summarize plugins.jsdoc.app · read 9 Oct 2026
- Purpose
- JSDoc is an API documentation generator for JavaScript that scans source code comments and generates an HTML documentation website.jsdoc.app · read 9 Oct 2026
- Runtime requirement
- The project README says JSDoc supports stable versions of Node.js 8.15.0 and later.github.com · read 9 Oct 2026
- Support
- The project README directs users to the JSDoc Users mailing list and Stack Overflow questions tagged `jsdoc` for help.github.com · read 9 Oct 2026
- Tags
- JSDoc tags add structured information to documentation comments, such as constructor and parameter details.jsdoc.app · read 9 Oct 2026
