<更新記録>
2008年 6月 16日
執筆
2008年 8月 24日
downloadできるバッチファイルの修正

姉妹サイトから検索 Web検索

SWT - JavaでGUIプログラミング
きままにインデックス
PHPノート
ゴルフ道具研究所


JsDoc-Toolkitを使う

Java実行環境

JsDoc-Toolkitを使用するには、Windowsの場合はJava VM6以降が、Mac OSの場合はJava VM5以降がインストールされている必要があります。
まだインストールされていない人は、JsDoc-Toolkitを使用する前にまずJava VMをインストールします。

ダウンロードとインストール

こちらからダウンロードして、適当なディレクトリで展開します。 今回はC:\JsDocに展開したものとして、その下にapp等のディレクトリがあるものとします。

次に、JsDocはそのままでは使いにくいので、呼び出しやすいようにバッチファイルを作成しましたので、 [ こちら ( zip ) ] からダウンロードして展開し、JsDoc-Toolkitを展開したディレクトリ(今回の例だとC:\JsDoc)の中に格納します。

JsDoc-Toolkitを展開したディレクトリ(C:\JsDoc)に環境変数を設定し、 コマンドプロンプトからjsdocと入力してエラーにならなければ設定は完了です。

設定が済んだら、

jsdoc mysrc.js mydestination

のようにコマンドを入力して使用します。
mysrc.jsはドキュメント化したいJavaScriptのソースファイル、mydestinationは作成したドキュメントを格納するディレクトリのパスです。 mydestinationは省略することができます。


Powered by VeryEasyCMS