ドキュメントの生成機能
モデリングの概念 への移動
モデリングのドキュメント生成機能は、UML モデリング プロジェクトのドキュメントを自動的に生成するものです。この機能を使用して、プログラムを HTML 形式のドキュメントで記述します。生成したドキュメントをプロジェクトの変更時に自動的に更新することも、後からこのドキュメントを手動で編集することもできます。
ドキュメント ファイル
生成されたすべてのドキュメント ファイルは、［ドキュメントの生成］ダイアログ ボックスの［出力フォルダ］で指定したドキュメント ディレクトリに書き出されます。デフォルトでは、生成されたドキュメントは Web ブラウザに表示されます。ドキュメントを直ちに表示しない場合でも、指定したドキュメント ディレクトリにある INDEX.HTML ファイルを使用して、後から表示できます。
HTML ドキュメント フレーム
HTML ドキュメントには、以下のフレームがあります。
- ダイアグラム フレーム（［ダイアグラムを含む］をオンにした場合）
- プロジェクトと概要フレーム（［ナビゲーション ツリーを含む］をオンにした場合）
- パッケージ リスト と パッケージ概要 フレーム（［ナビゲーション ツリーを含む］オプションをオフにした場合に、メイン フレームセットの左側に表示される）
- ドキュメント フレーム
［プロジェクト］タブをクリックして、プロジェクト ツリー ビューのノードを展開できます。［プロジェクト］タブにあるクラス名をクリックすると、ドキュメント ペインにドキュメントが表示されます。［プロジェクト］タブでダイアグラムを選択すると、そのダイアグラムがダイアグラム フレームに表示されます。ダイアグラム フレームの各要素は、ドキュメント フレームにハイパーリンクされています。ダイアグラム フレームで要素を選択すると、ドキュメント フレームにその内容が表示されます。
ドキュメント フレームにはソース コードとダイアグラムのドキュメントが表示され、HTML ドキュメントを生成するときに選択したすべてのオブジェクトが含まれます。ドキュメント フレームの上部に、プロジェクト ドキュメントを参照するためのナビゲーション バーがあります。
［プロジェクト］タブには、プロジェクトがツリー形式で表示されます。ノードを展開すると、個々のダイアグラムと要素が表示されます。クラスやインターフェイスをクリックすると、関連するドキュメントがドキュメント フレームに表示されます。