[Front-End General] JavaScript のドキュメンテーションツール JSDOC / ESDOC
memo.
JSDoc
インストール。
% npm install --save-dev jsdoc
実行。
% $(npm bin)/jsdoc src/ -r
拡張子が .js である必要があった。
/out ディレクトリに html が出力される。
ESDoc
インストール。
% npm install --save-dev esdoc
.esdoc.json を作成。
.esdoc.json
{
"source": "./src",
"destination": "./docs/esdoc"
}
実行。
% $(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 が出力される。
