FAQ
- Goal
- Difference between esdoc2 and JSDoc
- Supported Environment
- Import Path In Documentation
- Who's Using esdoc2
- Articles
Goal
esdoc2 has two goals.
- To make documentation maintenance comfortable and pleasant
- To create easy-to-understand documentation.
In order to achieve this two goals, esdoc2 produces a practical document, measures the coverage, integrates the test code and more.
Difference between esdoc2 and JSDoc
JSDoc is most popular JavaScript API Documentation tool. esdoc2 is inspired by JSDoc.
- esdoc2
- supports ES2015 and later
- targets at ES2015
classandimport/exportstyle - easy to use with fewer tags, because understand information from ES syntax.
- generates detailed document
- measures document coverage
- integrates test codes
- integrates manual
- JSDoc
- supports ES3/ES5 and ES2015
- targets Class-base OOP and Prototype-base OOP
- has many flexible document tags
Supported Environment
esdoc2 supports Node.js(v6 or later)
Import Path In Documentation
esdoc2 displays the import path of class/function into the document.
However, the import path may be different from real import path because usually ES modules is transpiled to use it.
So, esdoc2 Import Path Plugin converts import path to real import path.
Who's Using esdoc2
- RxJS
- Sketch API
- Netflix/unleash
- lonelyplanet/rizzo-next
- linkedin/hopscotch
- electron/electron-compile
And more.
Articles
- English
- Japanese