Understandを用いたレポート作成についてご紹介します。
Understandは解析したプロジェクトの情報の一部をHTMLおよびテキスト形式のレポートとして出力する機能があります。HTML形式のレポートの場合には、インデックスファイルも生成されるため、参照先をリンクから辿ることもできます。
出力する情報はメニュー[レポート]-[レポートの設定]から設定できます。
出力項目には、エンティティのリファレンス情報やプロジェクト・ファイルのメトリクスなどが用意されています。
出力項目は解析した言語により異なります。C/C++・Javaの場合にはデフォルトで出力項目の[Invocation Tree]以外を選択した状態になっています。出力項目については、必要に応じて選択してください。
レポートは以下の2通りの方法で作成できます。
- GUIによる操作
メニュー[レポート]-[レポートの生成]
- コマンドによる操作
以下のundコマンドを使用します。
> und report プロジェクト名
レポートの設定はその時点のプロジェクトの設定情報に基づいています。
undコマンドによる設定情報の参照と変更は、後日別の記事でご紹介します。
サンプルプログラム「fastgrep」のレポートは以下のようになります。
※レポート機能は日本語にも対応しています。
ソースコードの一部に日本語のコメントと命令文を追記しています。（300～301行目）
1つ目の画像では、「ファイルのメトリクス」と「関数の参照情報」を確認できます。
その他にも、インクルードファイルの参照情報やプロジェクト単位・関数単位でのメトリクスなども確認できます。
画像の文字色が青色になっているものは、参照先や定義ファイル（行数）やそのエンティティ（変数、関数、マクロ、ファイル、等）のリンクとなっており、様々な情報を参照できます。
レポート機能の詳細につきましては、Understandのメニュー[ヘルプ]-[ヘルプ]-[レポートの使用]、もしくはUnderstand 3.0 のユーザーズガイド（P177～P196）を参照ください。
作成したレポートはHTMLおよびテキスト形式のファイルであるため、Understandのライセンスが有効でない環境においても、もちろん参照できます。
チーム内等の情報共有にご活用ください。
