[Front-End General] JavaScript のドキュメンテーションツール JSDOC / ESDOC

memo.

[markdown]
## JSDoc

> * [jsdoc3/jsdoc: An API documentation generator for JavaScript.](https://github.com/jsdoc3/jsdoc)
> * [Use JSDoc: Index](http://usejsdoc.org/)
> * [JsDoc3-manual-jp](https://sites.google.com/site/jsdoc3manualjp/)

インストール。

“`prettyprinted
% npm install –save-dev jsdoc
“`

実行。

“`prettyprinted
% $(npm bin)/jsdoc src/ -r
“`

拡張子が .js である必要があった。
/out ディレクトリに html が出力される。

## ESDoc

> * [esdoc/esdoc: Good Documentation For JavaScript(ES2015)](https://github.com/esdoc/esdoc)
> * [ESDoc – The Good Documentation For JavaScript – クックパッド開発者ブログ](http://techlife.cookpad.com/entry/2015/12/22/100000)
> * [ESDoc を試す – アカベコマイリ](http://akabeko.me/blog/2015/07/esdoc/)

インストール。

“`prettyprinted
% npm install –save-dev esdoc
“`

.esdoc.json を作成。

“`json:.esdoc.json
{
“source”: “./src”,
“destination”: “./docs/esdoc”
}
“`

実行。

“`prettyprinted
% $(npm bin)/esdoc -c .esdoc.json
badge.svg
identifiers.html
index.html
function/index.html
variable/index.html
file/src/basic.es6.js.html
file/src/math.es6.js.html
./css
./script
./image
script/search_index.js
source.html
==================================
Coverage: 50% (1/2)
==================================
“`

設定した /docs/esdoc ディレクトリに html が出力される。

[/markdown]