HappyNetDoc♪.NETアプリケーションクラス仕様書生成ツール

[ドキュメント出力画面の説明]  [オプション画面の説明]  [ドキュメント出力例]

■バージョンアップのお知らせ　　Ver.2をリリースいたしました♪　(2011/8/5)

■ HappyNetDoc♪とは

HappyNetDoc♪とは、.NETアプリケーションのクラス仕様書を自動生成するツールです。
アセンブリファイル（EXE、DLLファイル）を入力し、(1)クラス一覧 (2)クラスごとのクラス変数やメソッドの一覧 (3)メソッドごとのパラメタの説明等をExcelファイル形式で出力します。
一般的には、プログラム設計書、関数仕様書、モジュール仕様書など、様々な呼び方がされていますが、本ツールではクラス仕様書と呼びます。（なお、生成するドキュメント中の仕様書名はテンプレートファイルを修正することで任意の名称に変更できます。）
ドキュメント類はExcelで作成されることが多いことを想定して、本ツールの出力はExcelファイルとしています。
設計・保守用のドキュメントを意識しているため、メソッドやクラス変数はPublicのみでなく、Privateスコープのものも出力します。

アセンブリファイルが入力となりますので、VB.NET、C#などの開発言語は問いません。
また、XMLコメントファイルがあれば、生成するドキュメント中のクラス名、変数名、メソッド名に対応するコメントを出力することができます。

さらに、VB.NET言語に限定される機能として、
VB.NETのソースファイルも入力することにより、クラス変数やメソッド(関数、サブプロシージャ)の参照関連をマトリクス（クロスリファレンス）で図示することができます。

この機能により、

• クラス変数やメソッドの変更によって影響を受けるメソッドを抽出したり、
• どこからも参照されない冗長なクラス変数やメソッドのチェックが簡単に行なえます。

また、クラスの参照関連やメソッドの呼び出し関連については、階層図（関連図）でも出力できます。
再帰的に呼び出されるメソッドの関連も示してくれます。
階層図は見栄えを重視しておりませんので、複雑な関連がある場合は線が入り乱れて見ずらい点、ご了承ください。
（出力例は、「本ツールが生成するExcelドキュメント」を参照してください。）

メソッドごとには、参照しているクラス変数の一覧やソースリストも出力します。

これらの項目の出力を必要としない場合は、提供するテンプレートファイルから不要な項目をExcelで編集・削除してご利用ください。

本ツールをプログラム変更時の波及影響調査（デグレード防止）や設計・保守ドキュメントを作成する際に役立てていただければ幸いです。

なお、本ツールが示す参照関連に漏れがある場合もありますので、変更影響の確認の際は、本ツールの出力結果だけチェックして安心しないでください。

■本ツールが生成するExcelドキュメント

⇒本ツールが生成するExcelドキュメントの出力例

（１）クラス一覧
アセンブリ単位に１つのファイルを生成します。
生成するファイル名： アセンブリ名_クラス仕様書.xls
目次シートに、アセンブリ名、名前空間、クラスの一覧、クラス階層図を出力


（２）クラス仕様書
クラスごとに１つのファイルを生成します。
生成するファイル名：(n)クラス名.xls    
ここで、 nは、クラス一覧表の項番です。サブクラスの場合は、n.n.n形式で階層番号がふられます。
（ａ）シート名：目次
              クラス名、クラス変数の一覧、メソッドの一覧、クロスリファレンス
（ｂ）シート名：目次シート内のメソッドの項番
  メソッドごと１シートに、メソッド名、パラメタ、参照クラス変数、メソッド階層図、ソースリストを出力

■前提条件

▽入力ファイル：

• .NETアプリケーションのアセンブリファイル(exe、dllファイル） （必須入力）
• XMLコメントファイル （任意）
• VB.NETのプロジェクトファイル、ソースファイル（VB2005またはVB2008）一式 （任意、クロスリファレンスなど、より詳細なドキュメント出力が可能）

▽出力ファイル：Excel2000形式をサポート

▽ツール実行に必要なソフトウェア

• Microsoft .NET Framework2.0 (SP2) 
• Microsoft Excel2000

　　（上記が前提ソフトウェアですが、Windows7 と Excel2010の環境でも動作確認いたしました。）

■提供ツール

HappyNetDoc♪ v.2.0  リリース日 2011年8月5日 改訂履歴

Vectorサイトよりダウンロード

【インストール方法】

1. [DownLoad]ボタンを押して、happynetdocsetup.zipをダウンロードする。
2. happynetdocsetup.zip(ZIP形式で圧縮したファイル)を解凍すると、ツール本体、テンプレートExcelファイルなどが解凍されます。
3. happynetdoc.exeを実行するとツールが起動できます。
   ⇒クラス仕様書の出力方法の詳細はこちら

【関連ツール】

• HappyForm♪ VB.NET画面仕様書生成ツール
  VB.NETのソースを入力して、画面レイアウト、入出力項目の説明を記述した画面仕様書をExcel形式で自動生成するツール

■使用許諾

1. 本ソフトウェアは、.NETアプリケーションの設計・保守用ドキュメントの作成工数の削減を目的とし、誰でも無償で使用することができます。
2. 本ソフトウェアの著作権および所有権は作者Amukzakが所有します。
3. 本ソフトウェアを改変して、別製品を作成することは禁じます。
4. 本ソフトウェアを使用して生じたいかなる損害に対して、作者は一切の責任を負いません。
5. 下記メールアドレスにバグや要望事項等を連絡することはできますが、その対応や迅速な回答のお約束はできません。

■制限事項・注意事項

1. 異なるパラメタをもつ同じ名前のメソッド名が存在し、パラメタの数が等しい場合は、参照関連の解析でメソッドを特定できずに、マトリクスには？を出力しています。
2. パラメタが異なる同じ名前のメソッドは、ドキュメント出力時にメソッド名の後に[連番]を付加して区別しています。
3. ドキュメント生成処理中に他のExcelファイルの編集操作は行えません。生成処理中にエラーとなります。
4. VB.NETのプロジェクトファイル、Application.myappファイルのエンコードはutf-8であること。
   utf-16で保存されているとクラス階層図の出力に失敗します。この場合、当ファイルの1行目のエンコードをutf-8に修正し、utf-8形式で保存し、再実行してください。
   なお、ソースファイルのエンコードについては本ツールの画面で指定します。

■問い合わせ先

   amukzak@gmail.com

    http://ameblo.jp/amukzak/  (アメブロへのリンク)