JSDoc

Overview

JSDoc is a documentation generator for JavaScript. You write documentation comments directly above code, and JSDoc parses those comments to generate API documentation.

Core principle: Document the public API clearly and keep comments colocated with code so docs stay accurate as implementation changes.

Comment rules

• JSDoc blocks must start with /** (exactly two stars after the slash).
• Blocks that start with /*, /***, or more stars are ignored by the JSDoc parser.
• Place the comment immediately before the symbol being documented (function, class, method, module, etc.).
• Prefer documenting public and reusable APIs first.