JavadocからExcelファイルを作るドックレット
本ドックレットは、指定したテンプレートを読み取ってExcelファイルを作ります。その為、体裁や書式を自由に変えられます。
また、手入力するセルを指定できます。手入力するセルは、ドックレットの更新対象外になります。具体的には、以下のようなことを行えます。
1: テンプレートからドキュメント生成
本ドックレットを使って、テンプレートファイルからドキュメントファイルを作ります。
2: 手入力セルを編集
ドキュメントファイルの手入力するセルを、自由に編集します。
3: ドキュメントファイル再生成
再び、本ドックレットを使ってドキュメントファイルを作っても、手入力した情報はそのまま残ります。
JavadocToドックレットを使う理由
ソフトウェアの納品物としてExcelで作った設計書が必要になることがあります。設計書とソースコードの内容が一致していれば問題なく納品できますが、開発が進むにつれ、食い違いがでてきてしまう可能性があります。開発スケジュールが厳しければ厳しいほど、そして開発メンバーが多ければ多いほど、その傾向は強いです。
その結果、ソースコードの内容を設計書に反映させる作業を行うことになります。それはとても時間がかかるうえ、新たな価値を生み出す生産性のある仕事ではありません。そのような作業はツールに行なわせ、開発者はもっと付加価値を生み出す仕事をすべきです。
JavadocToドックレットの対象利用者
Excelで作った設計書を要求されているJavaプログラマー、および設計者
ダウンロード
ダウンロードファイル名：
javadocto-1.00.zip
容量：
9.32Mb
インストール方法
JavadocTo-x.yy.zip(x.yyはバージョン番号)を任意のフォルダで展開してください。
実行方法
ドックレット名
jp.co.shin_gi.javadoc.ToExcel
ドックレット・クラスパス
- javadocto-x.yy.jar
- libフォルダにあるすべてのjar
固有のJavadocオプション
- -template テンプレートファイルのフルパス
- テンプレートファイルのフルパスを指定します。テンプレートファイルの種類は、以下のうちのいずれかになります。
- Excel ブック (*.xlsx)
- Excel マクロ有効ブック (*.xlsm)
- Excel 97-2003 ブック (*.xls)
- -out 出力先ディレクトリ
- ドキュメントファイルの出力先ディレクトリのフルパスを指定します。
- -classsheet シート名
- クラスに関するシートのシート名を指定します。省略時は、"class summary"というシート名になります。
- -tag タグ名
- 標準にはないJavadocタグを追加した場合、そのタグ名を指定します。このオプションは、複数指定できます。
- -var 変数名=値
- 処理全体で使う変数を指定します。たとえば、処理日付を指定するような場合に使います。このオプションは、複数指定できます。
テンプレートファイルの指定文字
テンプレートファイルに以下の指定文字を使うと、様々な情報を表せます。
- {author}
- @authorタグの値を表します。
- {since}
- @sinceタグの値を表します。
- {version}
- @versionタグの値を表します。
- {see}
- @seeタグの値を表します。
- {deprecated}
- @deprecatedタグの値を表します。
- {class}
- クラス名を表します。
- {qualifiedclass}
- クラスの完全修飾名を表します。
- {package}
- パッケージ名を表します。
- {method}
- メソッド名を表します。
- {summary}
- Javadocコメントのうち、最初の1行を表します。
- {comment}
- Javadocコメント全体を表します。
- {parameter[n].type}
- メソッドの引数の型の完全修飾名を表します。nは、0以上の数値です。引数のインデックスを示します。
- {parameter[n].name}
- メソッドの引数の名前を表します。nは、0以上の数値です。引数のインデックスを示します。
- {parameter[n].comment}
- @paramタグの値を表します。nは、0以上の数値です。引数のインデックスを示します。
- {modifiers}
- メソッドの修飾子を表します。たとえばメソッドが public abstract int mymethod() {……} の場合は、public abstractになります。
- {return.type}
- メソッドの戻り値の型の完全修飾名を表します。
- {return.comment}
- @returnタグの値を表します。
- {throws[n].type}
- メソッドが送出する例外の完全修飾名を表します。nは、0以上の数値です。例外のインデックスを示します。
- {throws[n].comment}
- @throwsタグの値を表します。nは、0以上の数値です。例外のインデックスを示します。
- {abstract?真の場合:偽の場合}
- クラスまたはメソッドがabstractかどうかの判定を表します。abstractなら真の場合に、そうでなければ偽の場合の文字列になります。偽の場合には空でよろしければ、":偽の場合"は省略可能です。
- {externalizable?真の場合:偽の場合}
- クラスがexternalizableかどうかの判定を表します。externalizableなら真の場合に、そうでなければ偽の場合の文字列になります。偽の場合には空でよろしければ、":偽の場合"は省略可能です。
- {final?真の場合:偽の場合}
- クラスまたはメソッドがfinalかどうかの判定を表します。finalなら真の場合に、そうでなければ偽の場合の文字列になります。偽の場合には空でよろしければ、":偽の場合"は省略可能です。
- {interface?真の場合:偽の場合}
- クラスがinterfaceかどうかの判定を表します。interfaceなら真の場合に、そうでなければ偽の場合の文字列になります。偽の場合には空でよろしければ、":偽の場合"は省略可能です。
- {native?真の場合:偽の場合}
- メソッドがnativeかどうかの判定を表します。nativeなら真の場合に、そうでなければ偽の場合の文字列になります。偽の場合には空でよろしければ、":偽の場合"は省略可能です。
- {packageprivate?真の場合:偽の場合}
- クラスまたはメソッドがpackage privateかどうかの判定を表します。package privateなら真の場合に、そうでなければ偽の場合の文字列になります。偽の場合には空でよろしければ、":偽の場合"は省略可能です。
- {private?真の場合:偽の場合}
- クラスまたはメソッドがprivateかどうかの判定を表します。privateなら真の場合に、そうでなければ偽の場合の文字列になります。偽の場合には空でよろしければ、":偽の場合"は省略可能です。
- {protected?真の場合:偽の場合}
- クラスまたはメソッドがprotectedかどうかの判定を表します。protectedなら真の場合に、そうでなければ偽の場合の文字列になります。偽の場合には空でよろしければ、":偽の場合"は省略可能です。
- {public?真の場合:偽の場合}
- クラスまたはメソッドがpublicかどうかの判定を表します。publicなら真の場合に、そうでなければ偽の場合の文字列になります。偽の場合には空でよろしければ、":偽の場合"は省略可能です。
- {serializable?真の場合:偽の場合}
- クラスがserializableかどうかの判定を表します。serializableなら真の場合に、そうでなければ偽の場合の文字列になります。偽の場合には空でよろしければ、":偽の場合"は省略可能です。
- {static?真の場合:偽の場合}
- クラスまたはメソッドがstaticかどうかの判定を表します。staticなら真の場合に、そうでなければ偽の場合の文字列になります。偽の場合には空でよろしければ、":偽の場合"は省略可能です。
- {synchronized?真の場合:偽の場合}
- メソッドがsynchronizedかどうかの判定を表します。synchronizedなら真の場合に、そうでなければ偽の場合の文字列になります。偽の場合には空でよろしければ、":偽の場合"は省略可能です。
- {manual}
- 手入力を表します。この記号のあるセルは、ドックレットで更新されません。出力先ファイルがすでに存在している場合、同じ位置にあるセルの値をそのまま使います。
- {ユーザー定義タグ}
- ドックレット・オプションの-tagで指定したユーザー定義タグを表します。たとえばJavadocコメントに @mytag 追加タグ と書いてあり、ドックレット・オプションに -tag mytag を指定した場合、テンプレートファイルの{mytag}は、追加タグになります。
- {変数名}
- ドックレット・オプションの-varで指定した変数を表します。たとえばドックレット・オプションに -var creation=2014/07/31 を指定した場合、テンプレートファイルの{creation}は、2014/07/31になります。