ITエンジニア/デザイナ向けにオープンソースを毎日紹介

JavaScriptによるWebアプリケーション開発がどんどん大規模化しています。多人数での開発も当たり前になり、継続的に開発する中でも品質を保たなければならなくなっています。

そんな中で必要になるのがドキュメントです。今回は最新のJavaScript仕様であるECMAScript 6に対応したJavaScriptドキュメントジェネレータ、ESDocを紹介します。

ESDocの使い方

ESDocのインストールはnpmで行います。

$ npm install -g esdoc

以下はコマンドオプションです。設定ファイルのJSONか、生成するスクリプトがあるディレクトリを指定します。

$ esdoc -h
usage: esdoc [-c esdoc.json | path/to/dir]

生成されたドキュメント(HTML)は次のようになります。

オブジェクトの詳細です。

ソースへのジャンプやハイライトにも対応しています。

ESDocはECMAScript 6のimport/exportであったり、classにも対応するようです。社内のライブラリをドキュメント化したり、外部の開発者が利用するSDKのドキュメントに使うのが良さそうです。

ESDocはnode/JavaScript製、MIT Licenseのオープンソース・ソフトウェアです。

ESDoc - An API Document Generator For JavaScript(ES6)

h13i32maru/esdoc

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2