モデリング - ドキュメントの生成オプション

提供: RAD Studio
移動先: 案内検索

[モデリング]オプション への移動

ツール > オプション... > モデリング > (レベル) > ドキュメントの生成

ここでの (レベル) は、[ドキュメントの生成] オプション ページが、モデリング オプション ツリーでの、プロジェクトプロジェクト グループ、および デフォルト のどのレベル(枝)に対して選択されるのかを、指定するために使用されます。 (さらなる情報については、「[モデリング オプション]ダイアログボックス」の「モデリング オプションの階層レベル」を参照してください。)


[ドキュメントの生成] オプションでは、ダイアグラムを説明するために生成する HTML ドキュメントに対して、さまざまなコンテンツの追加または除外や、生成されるドキュメント内に含まれる要素がどのように現れるかなどを、制御します。

[ドキュメントの生成] オプション

オプション 説明とデフォルト値

[最下部]

生成される各ドキュメント ファイルの最下部に記載されるテキストを指定します。
テキストは、下部ナビゲーション バーの右に出力されます。
テキスト内部に HTML タグや空白を使うことも可能です。

[ドキュメント タイトル]

生成される概要ページの上部に記載されるタイトルを指定します。
タイトルは、上部ナビゲーション バーの直下に、レベル 1 見出しとして、センタリングされて表示されます。
テキスト内部で HTML タグやホワイトスペースを使用することも可能です。

[フッター テキスト]

生成される各ドキュメント ファイルに記載されるフッター テキストを指定します。
フッターは、下部ナビゲーション バーの右側に表示されます。
テキスト内部で HTML タグやホワイトスペースを使用することも可能です。
フッターは、[ナビゲーション バー、ヘッダー、フッターの生成][はい]の場合に生成されます。

[ヘッダー テキスト]

生成される各ドキュメント ファイルに記載されるヘッダー テキストを指定します。
ヘッダーは、上部ナビゲーション バーの右側に表示されます。
テキスト内部で HTML タグやホワイトスペースを使用することも可能です。
ヘッダーは、[ナビゲーション バー、ヘッダー、フッターの生成]が[はい]の場合に生成されます。

[ナビゲーションの種類]

設計要素を記述する場所を定義します。

  • [パッケージ] - パッケージ ファイル内
  • [ダイアグラム] - ダイアグラムのファイル内

デフォルト値は[パッケージ]です。

[内部ブラウザを使用]

[はい] - ドキュメントの表示に内部ブラウザが使用されます。
デフォルト値は[いいえ]です。

[ウィンドウ タイトル]

生成される各ドキュメント ファイルの HTML <title> タグに与えられるタイトル テキストを指定します。
このテキストは、ウィンドウのタイトルや、ブラウザで作成されるデフォルトのブックマーク (お気に入り) に表示されます。
このタイトル内で HTML タグを使用しないでください。 ブラウザで正しく解釈できないからです。


[対象とするクラスとメンバ] オプション

オプション 説明とデフォルト値

internal (package)

[はい] - 生成されるドキュメントに internal (デザイン プロジェクトでは package) 可視性のクラス、インターフェイス、メンバが表示されます。
デフォルト値は[はい]です。

private

[はい] - 生成されるドキュメントに private 可視性のクラス、インターフェイス、メンバが表示されます。
デフォルト値は[いいえ]です。

protected

[はい] - 生成されるドキュメントに protected 可視性のクラス、インターフェイス、メンバが表示されます。
デフォルト値は[いいえ]です。

[protected internal]

[はい] - 生成されるドキュメントに protected internal 可視性のクラス、インターフェイス、メンバが表示されます。
デフォルト値は[いいえ]です。

public

[はい] - 生成されるドキュメントに public 可視性のクラス、インターフェイス、メンバが表示されます。
デフォルト値は[いいえ]です。


[ナビゲーション] オプション

オプション 説明とデフォルト値

[ヘルプの生成]

各ページ上部および下部のナビゲーション バーにヘルプ リンクを生成するかどうかを指定します。
デフォルト値は[はい]です。

[索引の生成]

各ページ上部および下部のナビゲーション バーに索引を生成するかどうかを指定します。
デフォルト値は[はい]です。

[ナビゲーション バー、ヘッダー、フッターの生成]

生成されるページの上部および下部にナビゲーション バー、ヘッダー、フッターを生成するかどうかを指定します。
デフォルト値は[はい]です。

[階層ツリーの生成]

クラス/インターフェイスの階層ツリーを生成するかどうかを指定します。
デフォルト値は[はい]です。

[使用の生成]

[はい] - ドキュメント化されるクラスおよび名前空間ごとに '使用' ページが生成されます。 このページには、特定のクラスまたはパッケージの API 要素が使用する名前空間、クラス、メソッド、コンストラクタ、フィールドが一覧表示されます。
たとえば、クラス C について考えると、これを使用する要素としては、C のサブクラス、C 型として宣言されたフィールド、C 型を返すメソッド、C 型のパラメータを持つメソッドやコンストラクタなどがあります。
デフォルト値は[いいえ]です。


関連項目