JsDoc ToolkitでJavaScriptのコメントからドキュメントを生成する
はじめに
JavaScriptのコメントからドキュメントを生成するツールには、以下のようなものがある。
名称 | 概要 | 記述言語 |
---|---|---|
YUI Doc | YAHOO! UI Libraryのドキュメント生成に使用 | python |
JSDoc | 元祖?javadocに類似したタグでコメント記述 | perl |
JsDoc Toolkit | JSDocの後継 | java |
本エントリでは、このうちJsDoc Toolkitの使用法を紹介する*1。より詳細な解説は、JsDoc Toolkit メモを参照されたい(リンク先ではJRE 5.0での実行方法を解説している)。
なお、JSDocのサイトを久しぶりに訪れて気付いたが、JSDocはJsDoc Toolkitを後継とし、開発をストップしたようだ(以下引用)。
NOTE: This project is no longer actively developed, as it has been superseded by JsDoc Toolkit.
概要
JavaScriptのコメントからドキュメントを生成するツールである。ツール自体はJavaで記述されており、javadocに類似した形式でコメントを記述できる。
ちなみに、生成されたドキュメントはIE 6.0ではうまく表示されない(Firefox 3.0.7、Safari 3.1、Opera 9.6.4だとうまく表示される)。何とも割り切ったツールである。
動作環境
このツールは、Java上でJavaScriptを動作させる「Rhino」を使用している。なので、JRE 6.0以上だとライブラリ追加なしで動作するが、JRE 5.0以下だとRhinoの追加インストール、および実行時のクラスパス指定が必要である。