Skip to content

See also

Tom MacWright edited this page Dec 4, 2017 · 18 revisions

documentation is a documentation generator for API documentation. It uses a code scanner and supports structured documentation, so it follows in the tradition of tools like JavaDoc, Natural Docs, and JSDoc. There are other camps of documentation generation, like literate documentation, which is less structured and more focused on understanding internal code structure.

Full-Fledged JSDoc

Literate Style

Testing for the presence of documentation

  • Inch CI measures the percentage of source code that is described by JSDoc comments

Testing documentation itself

  • jsdoctest tests code examples in @example tags.

JavaScript Syntax Extensions

Alternative Syntaxes

Standalone JSDoc Parsers

JSDoc to Markdown

JSDoc Parse APIs

TypeScript

React

JSDoc to Flow / as Flow

Mixed JSDoc & Narrative

You can’t perform that action at this time.