JSDoc is a documentation generator that produces API references from specially formatted comments embedded in JavaScript source files. It helps developers describe the public interfaces of applications and libraries while keeping the documentation alongside their code.
The application analyses source files, interprets documentation tags and generates interconnected HTML pages. Its annotation syntax supports modern JavaScript constructs, including classes, modules, methods and asynchronous functions. Developers can describe parameter types, return values, exceptions and examples without maintaining a separate API reference.
JSDoc is particularly useful for library authors who want consumers to understand how their code should be used. Its configurable processing system also makes it possible to tailor the documentation to an individual project’s conventions.
This is free and open source software.
Key Features
- Documents classes, interfaces, modules, namespaces, functions, methods, properties and events.
- Supports block and inline annotations for types, parameters, return values, exceptions, inheritance and deprecated functionality.
- Recognises ECMAScript modules, CommonJS modules and asynchronous functions.
- Generates navigable HTML documentation with links between related API elements.
- Includes a default output template that can be customised or replaced with third-party templates.
- Plugin architecture supports custom processing and additional source-code handling.
- Optional Markdown plugin enables formatted descriptions within documentation comments.
- Can incorporate README files, package metadata and standalone tutorials into generated documentation.
- Supports configuration files for controlling source selection, output settings and documentation behaviour.
Website: github.com/jsdoc/jsdoc
Support:
Developer: Michael Mathews and contributors
License: Apache License 2.0
JSDoc is written in JavaScript. Learn JavaScript with our recommended free books and free tutorials.
Related Software
| Documentation Generators | |
|---|---|
| JSDoc | API documentation generator for JavaScript |
| Javadoc | Generate API documentation in HTML format |
| Sphinx | Create intelligent and beautiful documentation for Python projects |
| phpDocumentor | Complete documentation solution for PHP |
| Doxygen | Documentation system for C, C++, Java, Python and other languages |
| Docusaurus | Build, deploy and maintain documentation websites |
| mdBook | Create modern online books from Markdown files |
| YARD | Ruby documentation tool |
| Starlight | Documentation website framework |
| Docco | Literate-programming-style documentation generator |
| Natural Docs | Documentation generator that supports 21 different languages |
| Quarto | Scientific and technical publishing system |
| Antora | Modular documentation site generator |
| Crycco | Quick and dirty documentation generator |
| ROBODoc | Documentation tool similar to Javadoc |
Read our verdict in the software roundup.
 LinuxLinks helps you discover the best free and open source software for Linux. Explore our extensive collection of recommended applications, including alternatives to popular proprietary software.We also publish software reviews, Linux tutorials, hardware reviews, free programming books and articles covering the wider open source community. Browse our Linux resources to discover more. Know a useful free and open source Linux application we haven't covered? Suggest a program for inclusion. Has your software been featured on LinuxLinks? Display one of our Featured on LinuxLinks badges on your website or GitHub README. |
Please read our Comment Policy before commenting.