-
Notifications
You must be signed in to change notification settings - Fork 485
See also
Tom MacWright edited this page Sep 9, 2016
·
19 revisions
documentationjs 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.
- http://usejsdoc.org/
- https://github.com/yui/yuidoc
- https://github.com/senchalabs/jsduck
- https://github.com/esdoc/esdoc
- http://nevir.github.io/groc/ (unmaintained)
- http://jashkenas.github.io/docco/
- Inch CI measures the percentage of source code that is described by JSDoc comments
-
jsdoctest tests code examples in
@exampletags.
- https://github.com/75lb/jsdoc-parse
- https://github.com/jonschlinkert/parse-comments
- https://github.com/75lb/dmd
- https://github.com/jdalton/docdown
- https://github.com/tmcw/doxme
- https://github.com/videojs/doc-generator
- https://github.com/daliwali/docchi
- https://github.com/aef-/hambruger
- https://github.com/llafuente/docr
- https://github.com/verbose/verb
- https://github.com/jonschlinkert/js-comments
- https://github.com/eslint/doctrine - this is what documentation.js uses
- https://github.com/hegemonic/catharsis - what jsdoc uses
- https://github.com/wkeese/js-doc-parse
- https://github.com/jonschlinkert/parse-comments
- https://github.com/Kuniwak/jsdoctypeparser - used by jscs-jsdoc