JDocHelper ホームページ
Current Version: 0.8.1
Last Modified: 2001/04/15
Since: 2001/04/09
JDocHelperはJavaソースファイルへのJavadocコメントの記述をサポートするツールです。クラス、メソッド、変数へJavadocコメントのテンプレートを自動的に挿入する機能だけでなく、ソースファイルを解析してメソッドの引数タグ(引数名)や例外タグ(例外クラス名)を自動付加する機能も備えています。各メソッド、変数、インナークラスの定義情報を取得して、それらをツリー表示できます。
GUIを備えていてJavadocコメントで記述したHTML文書がどう表示されるかをその場で確認できます。ソースファイルで定義されている全てのメソッド、変数、インナークラスをツリー表示されたメソッドなどに対応するソースコードを表示できるため、ソースコードブラウザとしても利用できます。
機能一覧
- Javadocコメントの自動付加
- ソースファイルのパースによる引数タグ、例外タグの自動作成
- Javadocコメントのチェック機能
- ソースコードの構造のツリー表示
- タグ情報の表形式での編集
- 記述したHTMLをその場で確認
- 編集中のJavadocに対応するメソッド(変数)ソースコードを表示
- 複数ソースファイルをまとめプロジェクトとして管理
- 表示するアクセス修飾子の指定
- クラスブラウザ機能
- I18N対応
- などなど…
インストールは、新たに一つディレクトリを作成し、ダウンロードしたファイルを解凍するだけです。
動作環境としてJava実行環境が必要です。環境がない方は別途ダウンロードしてセットアップしてください。
現在、下記の環境での動作を確認しています。
- JDK1.1 + Swing1.1.1
- JDK1.2
- JDK1.3
カレントディレクトリを解答先ディレクトリに移動します。そのディレクトリで付属のバッチファイル(シェルスクリプト)を実行するか、もしくは次のコマンドを実行すると起動できます。
- JDK1.2 or JDK1.3
> java -jar JDocHelper.jar
- JDK1.1 + Swing1.1.1
Windows
> java -classpath %CLASSPATH%;JDocHelper.jar
jp.gr.java_conf.a0.jdh.gui.MainWindow
UNIX
> java -classpath $CLASSPATH:JDocHelper.jar
jp.gr.java_conf.a0.jdh.gui.MainWindow
注意:CLASSPATHにはswingall.jarが含まれている必要があります。
ツールを起動後、ユーザのホームディレクトリに".jdh"というフォルダが作成され、そのフォルダ中にJDocHelperの設定情報が保存されます。
アンインストールは上記ディレクトリと、ファイルを解凍したディレクトリ以下を削除するだけです。
- ソースファイルが正常にコンパイルできることを確認する。
コンパイルできないソースファイルは正常にパースできません。JDocHelperで編集しようとしているソースファイルがjavacでコンパイルできることを確認しておいてください。
- JDocHelperを起動し、ファイルを追加する。
JDocHelperのメニューの「ファイル」-「追加」を指定して、編集したいJavaソースファイルを読み込みます。 デフォルトの設定では、読み込みと同時にファイルがパースされます。メソッドのJavadocコメントにはparamタグが自動付加されます(すでに記述済みの場合はその記述が認識され、自動付加されません)。
- 編集対象のメソッド、変数を参照する。
ツリー表示されたメソッド、変数から編集したいものをクリックすることで、その内容がウィンドウの右側に表示されます。上部がJavadocコメントとして記述されているもの(なにも記述されていないならば空白)で、下部には、そのJavadocコメント内で記述されているタグが表形式で表示さます。
ツリーで表示されているアイコンはアクセス修飾子によって変わります。デフォルトではprotectedとpublicのもののみが表示されています。メニューから「オプション」-「設定変更」を選択し、表示されたオプション設定ダイアログでで設定することで、privateのメソッドや変数も表示できます。
- Javadocコメントの編集を行う。
編集したいメソッド、変数のJavadocコメントの編集を行います。ツール内で編集を行っただけでは、元ソースファイルの更新はされません。編集を行ったメソッド、変数はボールドで表示されます。
- 編集をファイルに反映する。
必要な編集を終えたら、メニューから「ファイル」-「保存」を選択することで、対象ソースファイル名に".jdh"という文字列を付加した名前で保存されます。オプションで対象ソースファイルに上書きするように設定することも可能です。
リンクのない文書は現在準備中です。順次公開していく予定です。
JDocHelperに関する感想や提案などをメールにてお送りください。
-
JDocHelper User's Mailing List(英語)
ここから購読登録できます。
JDocHelperに関することであれば何でも!英語のみです。
-
JDocHelper Release Announce Mailing List(英語)
ここから購読登録できます。
JDocHelperのリリース連絡を受け取ることができます。
-
JDocHelper User's Mailing List(日本語)
ここから購読登録できます。
JDocHelperに関することであれば何でも!日本語用にメーリングリストを作成しました。
著作権情報
Copyright (C) 2001
Hiroyuki Kurokawa
最終更新日: 2001/04/15