JSDoc を作るため JSDocToolkit を使う

JavaScript で JavaDoc みたいなのを作るときは jsdoc-toolkit を使うみたいなので使ってみました。
使い方は簡単ですしはてなの他の方のブログなどにいくらでもやり方が載っているのですが…

jsdoc-toolkit はこちら
http://code.google.com/p/jsdoc-toolkit/

ここからダウンロードした zip を解凍して、そのディレクトリに移動したら以下を実行:

java -jar jsrun.jar app/run.js [JSのソースが入っているディレクトリのパス] -t=templates/jsdoc -d=[html を出力するパス]

コマンドラインオプションは
http://code.google.com/p/jsdoc-toolkit/wiki/CommandlineOptions

Eclipse で使う場合は外部ツールで実行
http://code.google.com/p/jsdoc-toolkit/wiki/OtherTools

Mac OS Xの場合こんな感じ

• Location はデフォで /usr/bin/java
• Working Directory は解凍した jsdoc-toolkit のディレクトリ
• Arguments は上に書いたやつから java を除けばおk

あとは Eclipse の設定の JavaScript -> Validator -> JSDoc でまずいコメントとかタグが足りないやつとかで警告が出るように設定したり、Problems ビューの Configure Contents で警告の表示範囲をしぼったりして今日はおしまい。