JsDocを使ってみたがうまくいかず。

圧縮版の次はAPIリファレンス、ということでGoogleさんに聞いたらでてきたJsDocを試してみました。が、ContainerJSはうまく変換できず。サンプルで付いてきたtest.jsはちゃんと変換できたのにー。

インストール

1. JsDocはPerlのスクリプトなので、Perlをインストールします。
   • cygwin版を使いました。cygwinのセットアップツールを使ってさくっとインストール。
2. JsDocのサイトからモジュールをダウンロードして展開します。
3. JsDocの依存モジュールであるHTML::Templateをインストールします。
   1. HTML-Templateのインストール方法にしたがって、CPANからダウンロードしてインストール。

サンプルを変換してみる。

JsDocを展開したディレクトリで以下のコマンドを実行します。

$ perl -w jsdoc.pl -d out test.js

実行すると、以下のメッセージが出力され、outディレクトリにAPIドキュメントが作成されます。

Loading sources from test.js
Completed generating documentation

ContainerJSを試してみたけど。

うまく変換できませんでした。怪しいところをコメントアウト(or削除)したり、必要そうなタグを追加したりしてみたけど、うまく動かず。原因も良くわからない。むー。