ESDoc
ESDoc is a documentation generator for JavaScript(ES6).
Feature
- Generates detailed documentation.
- Measures documentation coverage.
- Integrate test codes into documentation.
- Integrate manual into documentation.
- ESDoc Hosting Service
Demo
- ESDoc is self-hosting 😄
Install
npm install -g esdoc
esdoc -h
Usage
esdoc -c esdoc.json
Example
├── esdoc.json
└── src/MyClass.js
src/MyClass.js
/**
* this is MyClass.
*/
export default class MyClass {
/**
* @param {number} param this is param.
* @return {number} this is return.
*/
method(param){}
}esdoc.json
{
"source": "./src",
"destination": "./esdoc"
}exec esdoc
esdoc -c esdoc.json
open ./esdoc/index.html
Document
please visit esdoc.org to see more documentation.
License
MIT