JSDoc Documentation Tool

JSDoc is a documentation generation tool for JavaScript created by Michael Mathews in 2011, providing API documentation through structured comments in source code, with the comment format using special tags including at-param for function parameters, at-returns for return values, at-typedef for type definitions, at-property for object properties, at-class for classes, at-extends for inheritance, at-example for code examples, at-see for cross-references, at-deprecated for deprecation notices, at-since for version information, at-throws for exceptions, at-async for asynchronous functions, and at-template for generics, generating HTML documentation with navigation, search, type information, inheritance hierarchies, and source code links. The parsing engine processes JavaScript and TypeScript source files, extracting JSDoc comments that immediately precede declarations, with the parser understanding JavaScript syntax including function declarations, arrow functions, class declarations, method definitions, variable declarations, and TypeScript type annotations, automatically inferring types from default values, return statements, and TypeScript annotations when explicit JSDoc types are not provided. The template system uses Handlebars for generating HTML output, with the default template providing a clean, responsive layout with a sidebar navigation, class and module listings, type definitions, inheritance trees, and syntax-highlighted source code, while custom templates enable teams to match their documentation style, and the publishing system supports plugins for additional output formats. The type system supports complex types including unions, intersections, records, functions, arrays, and generic types. The namespace support. The module system. The tutorial integration. The plugin architecture. The configuration file. Designed by Michael Mathews. Designed for JavaScript developers.