コマンド ラインからドキュメント生成を実行する

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

ドキュメント生成の手順 への移動

コマンド ラインから GenDocCLI.EXE を実行し、モデリング プロジェクトに関する HTML 形式のドキュメントを生成することができます。GenDocCLI.EXE は 2 つのモードで実行できます。

  • ヘルプの表示
  • ドキュメントの生成

コンソール ウィンドウにヘルプを表示する

  1. コマンド インタープリタを起動するには、［スタート］をクリックした後、［ファイル名を指定して実行...］をクリックします。［ファイル名を指定して実行］ダイアログ ボックスで、［名前］フィールドに「cmd」と入力し、［OK］をクリックします。コマンド インタープリタが開きます。
  2. コマンド インタープリタのコマンド プロンプトで、RAD Studio のインストール ディレクトリの \bin というサブディレクトリに移動します。たとえば、次のコマンドを実行します。
    cd "C:\Program Files (x86)\Embarcadero\Studio\19.0\bin"
  1. 次のコマンド ラインのいずれかを実行します。


GenDocCLI -h GenDocCLI --help

GenDocCLI.EXE の使い方を短くまとめた説明がコンソール ウィンドウに表示されます。

モデリング プロジェクトのドキュメントを生成する

  1. コマンド インタープリタを起動します。
  2. コマンド プロンプトで GenDocCLI.EXE アプリケーションを呼び出して、ドキュメント生成ツールを実行します。次のようなコマンド ラインを実行してください。
GenDocCLI <オプション>
使用可能なオプションの説明は、「ドキュメントの生成機能」の「コマンド ライン ドキュメント生成ツール： GenDocCLI.EXE」セクションを参照してください。

例

以下に示すのは、コマンド ラインからドキュメント生成を実行する例です。 

GenDocCLI.exe --without-diagrams --without-navigation -q^
 -U"C:\Program Files (x86)\Embarcadero\Studio\19.0\lib\release"^
 -I"C:\Program Files (x86)\Embarcadero\Studio\19.0\lib";"C:\Program Files (x86)\Embarcadero\Studio\19.0\include"^
 -DDEBUG;DEVELOPERS;^ 
 -o "C:\Users\<user>\Documents\Embarcadero\Studio\Projects\p1\out\Doc"^
 "C:\Users\<user>\Documents\Embarcadero\Studio\Projects\p1\Project1.dproj"

コマンドライン オプション

ここでは、次のオプションの使用法の例を示します。

  • --without-diagrams -- GenDocCLI.EXE が、生成される HTML 形式のドキュメント ファイルにダイアグラムの画像を挿入しないよう指定します。
  • --without-navigation -- GenDocCLI.EXE が、生成されるドキュメント ファイルにナビゲーション ツリーを含めないよう指定します。
  • -q -- GenDocCLI.EXE のサービス メッセージをコンソール ウィンドウに表示しないよう指定します。
  • -U -- GenDocCLI.EXE が、コンパイル済みユニットを C:\Program Files (x86)\Embarcadero\Studio\19.0\lib\release フォルダで検索するよう指定します。
  • -I -- GenDocCLI.EXE が、インクルード ディレクトリとして C:\Program Files (x86)\Embarcadero\Studio\19.0\lib および C:\Program Files (x86)\Embarcadero\Studio\19.0\include を使用するよう指定します。
  • -D -- GenDocCLI.EXE が、DEBUG および DEVELOPERS という条件付きコンパイル シンボルを使用するよう指定します。
  • -o -- GenDocCLI.EXE が、生成する HTML ファイルやその他のドキュメント ファイルを C:\Users\<user>\Documents\Embarcadero\Studio\Projects\p1\out\Doc サブディレクトリに保存するよう指定します。-o と指定するパスの間には空白文字を 1 つ含めてもかまいません。
  • Project1.dproj ファイルは、ソース コードおよび UML モデルのドキュメントを生成する対象の Delphi プロジェクト ファイルです。指定した Delphi プロジェクトのモデリング サポートが有効になっていない場合、GenDocCLI.exe はプロジェクトのソースを分析して、必要なすべてのクラス図を自動的に生成します。

関連項目

「https://docwiki.embarcadero.com/RADStudio/Tokyo/j/index.php?title=コマンド_ラインからドキュメント生成を実行する&oldid=213799」から取得