EclipseからJSDocってみた件

環境構築

JSDoc(JavaScript Documentation Tool)*1をインストールしてみた。といってもPerlなのでダウンロードして適当なフォルダに突っ込んだだけ。CPANのHtml-Templateを利用するからのでDOSプロンプトで以下のコマンド叩いてインストール。Windowsは標準でPerlを利用できないのでActivePerlとかインストールしておきましょう。

ppm
install HTML-Template

JSDocとは

JavaDocのJavaScript版でPerlで書かれています。:-)

ためしに
perl C:\Perl\lib\JSDoc\jsdoc.pl C:\Perl\lib\JSDoc\test.js

と叩くと自動的にドキュメントが作成される。

問題点

perl C:\Perl\lib\JSDoc\jsdoc.pl C:\Hoge\test.js
perl C:\Perl\lib\JSDoc\jsdoc.pl C:\Foo\foo.js
perl C:\Perl\lib\JSDoc\jsdoc.pl C:\Bar\bar.js

いい加減暴れそうになる(　´_ゝ｀)CUIベースなので毎回毎回コマンド叩くのめんどう。

Eclipseと連携

メインの開発環境がEclipseなので何かエレガントにJSDocれないかと考察して3分。Eclipseは日本語化されていると仮定した場合[実行]→[外部ツール]→[外部ツール]にて以下のように設定します。環境は個別では違うと思いますので環境にあったように設定お願いします。

設定内容


  1. 名前は JSDoc でいいと思います。
  2. ロケーションはPerlのperl.exeのパス(例:C:\Perl\bin\perl.exe)
  3. 作業ディレクトリーは適当に…
  4. 引数は 【jsdoc.pl】 -d【プロジェクトディレクトリのパス】 【リソースファイル変数 or プロジェクトディレクトリのパス】みたいな形にするといいと思います。
  • dオプションでJSDocによって作成されたHTMLファイルをどこに出力される確認します。
  • Windowsの場合はMy Documentsとかスペースが入っていると思うので"2重引用符"でくくります。
次回起動の方法

[実行]→[外部ツール]→[JSDoc]で起動。

おしまい。

*1:JavaDocやPHPDocのJavaScript版 : http://jsdoc.sourceforge.net/