HTML作成

Ver10.0 (2024年10月30日リリース) 機能改善

作成したモデルをブラウザで閲覧できるHTML形式で出力します。
図上のクラスのリンクから、クラスの詳細を参照することができます。

  1. メインメニュー[ツール]-[HTML作成(javadoc)]をクリックする
  2. ドキュメントを作成するフォルダを指定して [選択]をクリックする
  3. 指定したフォルダにある index.html を開いて、HTMLドキュメントを表示します。
  4. メニュー[パッケージ]、[クラス]、[階層ツリー]からクラスを選択して、詳細情報を表示できます。
    右上のメニュー[図]をクリックすると図のリストが表示され、図上のクラスをクリックすると
    クラスの詳細情報が表示されます。

HTML作成 - システムプロパティ

細かい設定を行えます。


RTF出力

パッケージ、クラス、ユースケースの一覧、各図のイメージ、クラスの詳細(属性、操作)といったプロジェクトの詳細なドキュメントをリッチテキスト形式で作成します。
オプションで詳細なカスタマイズも可能で、納品ドキュメントの作成などにも便利です。例えば、javaソースコードを読みこんだプロジェクトをドキュメントに出力し、各クラスの概要を把握するといった利用ができます。


出力したRTFドキュメントのサンプル

設計ドキュメントに含められる情報

  • パッケージ一覧
  • クラス一覧
  • ユースケース一覧
  • データフロー図のモデル一覧
  • 要求一覧
  • テストケース一覧
  • クラス図、ユースケース図などの各図
  • ユースケース記述
  • クラス、属性、操作の詳細など
  • アクティビティ図やデータフロー図の階層構造
  • アクションのプロパティ(定義、タグ付き値など)

RTFドキュメント作成の手順

  1. メインメニュー[ツール]-[RTFドキュメント作成]を選択する
  2. RTFドキュメント作成ダイアログで、次の項目を設定する
    ・作成対象をツリーから選択
    ・ファイル名を直接入力するか、[選択]ボタンから指定
    ・[オプション]ボタンから出力する項目などを詳細設定、ここでフォントを選択可能
    ・ページ設定(オプションの詳細は、「作成したドキュメントを自動的に開く」にチェックを付けると、作成完了後、自動でRTFが開きます。
    RTF出力のダイアログ
  3. [作成]ボタンを押下し、数秒~数十秒(作成対象が多いほど時間がかかります)で、完了のダイアログが表示される。

オプション

基本
項目名 デフォルト・説明
概要 ここに記述した内容が、作成したドキュメントの冒頭に記されます。
パッケージ一覧 ON
クラス一覧(パッケージごと) ON
ユースケース一覧(パッケージごと) ON
データフロー図のモデル一覧(パッケージごと) ON
要求一覧(パッケージごと) ON
テストケース一覧(パッケージごと) ON
選択外パッケージの関連したモデルも記載する ON
ハイパーリンク情報を含める ON
一覧の名前欄にステレオタイプも記載する OFF
項目の内容が空のときにその項目のタイトルを省略する OFF
空のパッケージを出力する ON
パッケージごとに新しいページにする ON
一覧では定義の3行目まで出力する OFF
値が空のカスタムプロパティも出力する ON
参照プロジェクトのモデルは出力しない OFF
ONにすると、参照元プロジェクトのモデルの後に、参照プロジェクトのモデルが出力されます。

項目名 デフォルト・内容
図のイメージのフォーマット *.PNG (JPG、EMFも選択可能)
図のイメージをリンクで参照する OFF
図を表示するにはフォントタブで正しいロケールを選択する必要がある。
空の図も出力する ON
クラス図、ユースケース図、ステートマシン図、アクティビティ図、シーケンス図、コミュニケーション図、コンポーネント図、配置図、合成構造図 ON
アクティビティ図の階層構造を出力する ON
フローチャート、データフロー図、ER図、CRUD、要求図、要求テーブル、トレーサビリティマップ ON
データフロー図の階層構造を出力する ON
マインドマップのイメージを含める ON

モデル

モデルはデフォルトがONで、出力される設定です。

  • クラス
  • パッケージ
  • サブシステム
  • モデル
  • 関連クラス
  • インタフェース
  • エンティティ
  • バウンダリ
  • コントロール
  • アクター
  • ユースケース
  • アクティビティ図の詳細
  • データフロー図の詳細
  • 外部エンティティ
  • データストア
  • ERエンティティ
  • 要求
  • テストケース

属性/操作

デフォルトはONで、出力される設定です。

  • Public / Protected / Package / Private

ユースケース

ユースケース記述を出力するかどうかを指定できます。デフォルトはONです。


関係(ソースからターゲット)の設定

ソースからターゲットへの関係線の出力を指定します。デフォルトはONです。

  • テンプレートバインディング / 関連 / 汎化 / 実現 / 依存 / 拡張 / 包含

関係(ターゲットからソース)の設定

ターゲットからソースへの関係線の出力を指定します。デフォルトはOFFで、項目はソースからターゲットと同じです。


フォントの設定

ドキュメントに使用するフォントを指定します。