JsDoc Toolkit2007年06月27日 01時30分29秒

JavaScriptでJavaScriptのドキュメントを生成する

JsDoc Toolkit(via: mal_blue@tumblr)

javadocPHPDocといった、ドキュメントコメントからAPIドキュメントを生成するツールがある。

JavaScript向けにもPerlで作成されたJSDocがあるのだが、今回のネタ「JsDoc Toolkit」はこれのJavaScript実装だ。

追記(2007.06.27 02:13)

「JSDoc」のリンク先(あるSEのつぶやきさん)の記事は、MOONGIFTさんの記事なのだが、サイト構成が当時と変わっているためトップページへ飛ばされてしまう。なので現在のリンクを以下に示しておく。

すばらしい、と思いきや

たしかにアーカイブに含まれるソースは.jsファイルのみで、サイトにあるJsDoc Toolkit is written in 100% JavaScript.に偽りはないっちゃないのだが、実行環境がRhinoに限定されているようなのだ。要するにJREがインストールされている上(これは別に問題ないか)、Rhino落としてきてコマンドラインから

 > java -jar c:\Java\js.jar lib\JsDoc.js -t=templates\sunny tests\data\
みたいにせにゃならんということだ。むぅ。

一応覗いてみるが

なんとかcscript環境下で使えるようにできんかと思って、ソースをちょっとだけ見てみたんだけど、

(new File(dirName)).mkdir();
だの、
var out = new FileWriter(outpath);
だのと、あまりにもあたりまえのようにJavaのクラスライブラリをさらっと使っているので、どれがJavaのAPIなのかを探るだけでもかなりホネで、なかなかしんどそうだ。

ファイルIOとコマンドライン引数の受け取りだけでもうまいこと抽象化しといてくれれば誰かが勝手にSpiderMonkey対応だのcscript対応だのjsdb対応だのしてくれると思うんだけどなぁ。

がんばってjava.io.*のエミュレーション層を作ってみようか。無理だ