.NETアプリの設計書をExcel形式で自動生成(VB.NETの場合はクロスリファレンス出力可)
- ソフト名 ：HappyNetDoc♪ .NETアプリ・クラス仕様書生成ツール
- バージョン ：2.0
- ライセンス ：フリーソフト
- OS ：Windows
- 開発 ：Amukzak
HappyNetDoc♪ .NETアプリ・クラス仕様書生成ツール詳細
HappyNetDoc♪とは、.NETアプリケーションのクラス仕様書を自動生成するツールです。
アセンブリファイル(EXE、DLLファイル)を入力し、(1)クラス一覧(2)クラスごとのクラス変数やメソッドの一覧(3)メソッドごとのパラメタの説明等をExcelファイル形式で出力します。
一般的には、プログラム設計書、関数仕様書、モジュール仕様書など、様々な呼び方がされていますが、本ツールではクラス仕様書と呼びます。
(なお、生成するドキュメント中の仕様書名はテンプレートファイルを修正することで任意の名称に変更できます。)
ドキュメント類はExcelで作成されることが多いことを想定して、本ツールの出力はExcelファイルとしています。
設計・保守用のドキュメントを意識しているため、メソッドやクラス変数はPublicのみでなく、Privateスコープのものも出力します。
アセンブリファイルが入力となりますので、VB.NET、C#などの開発言語は問いません。
また、XMLコメントファイルがあれば、生成するドキュメント中のクラス名、変数名、メソッド名に対応するコメントを出力することができます。
さらに、VB.NET言語に限定される機能として、
VB.NETのソースファイルも入力することにより、クラス変数やメソッドの参照関連をマトリクス(クロスリファレンス)で図示することができます。
この機能により、
・クラス変数やメソッドの変更によって影響を受けるメソッドを抽出したり、
・どこからも参照されない冗長なクラス変数やメソッドのチェックが簡単に行なえます。
また、クラスの参照関連やメソッドの呼び出し関連については、階層図(関連図)でも出力できます。
再帰的に呼び出されるメソッドの関連も示してくれます。
メソッドごとには、参照しているクラス変数の一覧やソースリストも出力します。
これらの項目の出力を必要としない場合は、提供するテンプレートファイルから不要な項目をExcelで編集・削除してご利用ください。
本ツールをプログラム変更時の波及影響調査(デグレード防止)や設計・保守ドキュメントを作成する際に役立てていただければ幸いです。
詳細は、下記Webをご参照ください。
<http://happyform.web.fc2.com/happynetdoc>
【関連ツール】
HappyForm♪VB.NET画面仕様書生成ツール