2009.03.30追記
JsDoc Toolkit2.xでは、ディレクトリの構成が変わっていて、このエントリに記載した方法ではうまくいかないため、以下のエントリを参照してください。
はじめに
JSDocというJavascript用のドキュメントジェネレータがあるのを何日か前に知り、試してみようと思ったのだけど、Perlのモジュールを入れたりとPerl使いじゃない僕には分からないことが多く、敷居が高いなあと思っていた矢先、JsDoc Toolkitというツールがあることを知った。
JsDoc Toolkitは、JSDocのJavascript移植版らしい。実際にはJREを使って、HTMLドキュメントを生成しているみたいだけど、とりあえず今日試したところまでをメモ。
JsDoc Toolkitのインストール
- JsDoc Toolkitから画面右にあるProject Pageをクリック。
- Project Pageが表示されたら、画面右にあるFeatured Downloads:をクリックして、モジュールをダウンロードする。
- zip圧縮されているので、適当なディレクトリへ保存した後、解凍する。
JsDoc Toolkitを動かしてみる
- JsDoc Toolkitのインストールディレクトリ配下に適当なディレクトリ（work）を作成する。
- 1で作成したディレクトリ配下に、ドキュメントを作成する対象のjsファイル（sample.js）を置く。
cd jsdoc_toolkit-1.4.0 java -jar app/js.jar app/run.js -t=templates/sweet work/sample.js
※-t=templates/sweetというオプションは、HTMLのテンプレートを選択している。
JsDoc Toolkitのインストールディレクトリ配下のjs_docs_outディレクトリに、htmlファイルが生成されているので、ブラウザでindex.htmlを表示してみる。
