JsDoc Toolkitを使う!

インストール

最終更新:

aias-jsdoctoolkit

- view
管理者のみ編集可

トップページ >

インストール

このページでは、JsDoc Toolkitとその動作環境のセットアップ手順について説明します。
なお以下の作業において、OSはWindowsとします。

JREのインストール

まだインストールされていなければ、JsDoc Toolkitの動作環境であるJRE(Java Runtime Environment)をインストールします。バージョン2.3.2の時点で公式に動作確認されているJREのバージョンは下表のとおりですが、特に理由がなければ、その時点の最新のバージョンを利用することをお勧めします。

Windows XP java version "1.6.0_03"; Java(TM) SE Runtime Environment (build 1.6.0_03-b05)
Mac OS X 10.5 java version "1.5.0_19"; Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_19-b02-304)
  • 2009年9月時点の最新バージョンは、JRE6 Update16 です。

以下のインストール手順は2009年5月時点のものです。バージョンアップ等により手順が変更される可能性がありますのでご注意ください。

  1. ダウンロードサイト(http://java.sun.com/javase/ja/6/download.html)にアクセスします。
  2. JREの欄にある[ダウンロード]ボタンをクリック。
  3. 移動先のページで下のように選択し、[Continue>>]ボタンをクリック。
    • Platform : Windows
    • Language : Multi-language
    • 「I agree to the Java ...」にチェック
  4. 移動先のページで、ダウンロードを開始します。インストーラファイルへのリンク(バージョンによって名前は異なりますが、例えば jre-6u13-windows-i586-p.exe)をクリックし、任意のディレクトリにファイルを保存します。
  5. ダウンロードしたインストーラファイルをダブルクリックし、インストーラを起動します。後の操作はインストーラの指示に従ってください。
    • JRE6 Update13のインストーラの場合、インストールディレクトリをデフォルトから変更するには最初の画面で「インストール先フォルダの変更」にチェックをつける必要がありますので注意してください。
  6. インストールに成功したら、[完了]ボタンをクリックしてインストーラを閉じます。これでJREのインストールは完了です。
    • JsDoc Toolkitの実行を簡単にするために、インストール完了後「%JREのインストールディレクトリ%\bin」にパスを通しておくことをお勧めします。

付記:Rhinoのインストールについて

JsDoc ToolkitはJavaによるJavaScriptの実装であるRhino上で動作します。そのためJREに続いてRhinoのインストールとなりそうですが、実際にはRhinoのインストールは特に必要ありません。JsDoc ToolkitのディストリビューションにはRhinoの実行形式ファイルが同梱(java/classes/js.jar)されており、jsrun.jarを使用する標準的な実行方法では、自動的にこれが呼び出されるようになっているからです。

JsDoc Toolkitのインストール

  1. ダウンロードサイト(http://code.google.com/p/jsdoc-toolkit/downloads/list)にアクセスします。
  2. zipファイルへのリンクをクリックし、ファイルを任意のディレクトリに保存します。
  3. 保存したzipファイルを任意のディレクトリに展開したら、JsDoc Toolkitのインストールは完了です。

関連項目

  • JsDoc Toolkitのためのドックコメントの書き方については、こちらを参照してください。
  • JsDoc Toolkitによるドキュメントの作成手順については、こちらを参照してください。

目安箱バナー