- PR -

プログラム上からのJavadoc情報の取得

1
投稿者投稿内容
タミ
会議室デビュー日: 2005/06/24
投稿数: 2
お住まい・勤務地: 東京
投稿日時: 2006-09-02 11:39
お世話になります。
Javaファイルを読み込み(1行1行独自解析せずに)
Javadoc情報をJavaプログラムより取得することは可能なのでしょうか?

【背景】
Javaプログラムのクラス情報をJavadoc(HTML形式)ではなく,
Excelとして一覧表で作成する必要があります。
(クラスID,メソッドID,例外,クラス和名,メソッド和名...)

そこで以下のような手順でのツールの作成を考えております。
@JarFile,JarEntry,URLClassLoaderなどを利用して各種Class情報を取得。
A取得した情報からPOIを利用してExcelに出力。

クラスIDやメソッドID,例外ID等はJavaプログラムより容易に取得できると思いますが,
各種和名はJavadocタグ等より取得する他無いと考えております。

ツール作成に辺り,どのようにすれば良いかのアドバイスをお願いいたします。
どうしようも無い場合は(Java or VBAで)一行ずつ解析しようかと思います。
(ツール等をご存知でしたらそちらでも問題ございません。)

宜しくお願い致します。
かつのり
ぬし
会議室デビュー日: 2004/03/18
投稿数: 2015
お住まい・勤務地: 札幌
投稿日時: 2006-09-02 12:04
カスタムドックレットを使用することによって可能です。

http://java.sun.com/j2se/1.5.0/ja/docs/ja/guide/javadoc/doclet/overview.html

一般的なJavadocもデフォルトで使用されるだけで、ドックレットの1つになります。
ドックレットは対象ソース、関連ソースを読みながら、
Javadocコメントや、クラス構造などを解析してくれます。
タミ
会議室デビュー日: 2005/06/24
投稿数: 2
お住まい・勤務地: 東京
投稿日時: 2006-09-03 09:48
>かつのり様

ご回答ありがとうございました。
以前カスタムドックレットをほんの少しだけ利用したことがありますが、Javadoc上に独自のタグを定義するだけのものかと勘違いしておりました。

リンクページの以下の記載のようにHTML形式以外の出力も可能なのですね。

>このドックレットは結果を標準出力に出力しますが、出力の形式は変更可能です
>(HTML 形式の出力をファイルに書き出すなど)。

調べ方が全然足りなかったようで申し訳ございません。
独自ドックレットによりExcelに出力する方向で検討してみようと思います。
1

スキルアップ/キャリアアップ(JOB@IT)