Main Content

このページの翻訳は最新ではありません。ここをクリックして、英語の最新版を参照してください。

Simulink Report Generator による生成コードのドキュメント化

Simulink® Report Generator™ ソフトウェアは、モデルから HTML、PDF、RTF、Microsoft Word および XML など、複数形式のドキュメンテーションを作成できます。この例では、コード生成プロジェクトを Microsoft® Word にドキュメント化する 1 つの方法を示しています。生成レポートには以下の内容が含まれます。

  • システムのスナップショット (モデルとサブシステムの図)

  • ブロックの実行順序の一覧

  • 生成されたコードの Simulink Coder™ とモデルのバージョン情報

  • 生成されたファイルの一覧

  • 最適化コンフィギュレーション パラメーターの設定

  • システム ターゲット ファイルの選択およびビルド プロセスのコンフィギュレーション パラメーター設定

  • サブシステムの配置

  • ソース コードのファイル名、パスおよび生成コードの一覧

カスタム コードを含めるよう Simulink Report Generator 設定を調整してからモデルのレポートを生成するには、次のタスクを完了します。

Simulink Report Generator ライセンスは、PDF、RTF、Microsoft Word、XML のレポート形式に必要です。これらの形式でレポートを生成する方法の詳細については、Simulink Report Generator ドキュメンテーションを参照してください。

モデルのコード生成

Report Generator を使用したプロジェクトをドキュメント化するには、まずモデルのコードを生成します。

  1. MATLAB® の現在のフォルダー ブラウザーで、書き込みアクセス権があるフォルダーに移動します。

  2. MATLAB コマンド ラインで次のように入力して、作業フォルダーを作成します。

    mkdir report_ex
  3. report_ex を作業フォルダーにします。

    cd report_ex
  4. MATLAB コマンド ラインでモデル名を入力して slexAircraftExample モデルを開きます。

  5. [シミュレーション] タブの [保存] リストで、[名前を付けて保存] を選択します。作業フォルダー report_ex に移動し、slexAircraftExample モデルのコピーを myModel という名前で保存します。

  6. [コンフィギュレーション パラメーター] ダイアログ ボックスを開きます。[ソルバー][ソルバーの選択][タイプ] パラメーターを [固定ステップ] に設定します。

  7. [コード生成] ペインを選択します。[コード生成のみ] を選択します。

  8. [適用] をクリックします。

  9. モデル ウィンドウで、Ctrl+B を押します。ビルド プロセスによってモデルのコードが生成されます。

Report Generator を開く

コードを生成したら、Report Generator を開きます。

  1. Report Generator アプリを開きます。モデルのブロック線図ウィンドウの [アプリ] ギャラリーで、[Report Generator] をクリックします。

  2. レポート エクスプローラー ウィンドウのオプション ペイン (中央) で、rtw (\toolbox\rtw) フォルダーをクリックします。そこにある設定ファイル codegen.rpt をクリックします。

  3. codegen.rpt をダブルクリックするか、このファイルを選択して [レポートを開く] ボタンをクリックします。レポート エクスプローラーで、アウトライン ペイン (左側) に設定ファイルの構造が表示されます。

レポートの名前、場所および形式の設定

レポートを生成する前に、フォルダー、ファイル名、形式などのレポートの出力オプションを指定できます。たとえば、MyCGModelReport.rtf という名前の Microsoft Word レポートを生成するには以下の手順に従います。

  1. プロパティ ペインの [レポート オプション] に一覧表示されているオプションを確認します。

  2. [ディレクトリ] フィールドは [現在の作業ディレクトリ] に設定したままにします。

  3. [ファイル名] として [カスタム] を選択します。index を名前 MyModelCGReport で置き換えます。

  4. [ファイル形式][リッチ テキスト形式] を指定し、[標準印刷][番号付きの章&節] で置き換えます。

レポートに含めるモデルとサブシステムの指定

Model Loop コンポーネントのオプションを設定して、生成されるレポートに含めるモデルとサブシステムを指定します。

  1. アウトライン ペイン (左側) で [モデル ループ] をクリックします。Report Generator によって、プロパティ ペインに Model Loop コンポーネントのオプションが表示されます。

  2. まだ選択していない場合は、[モデル名] オプションに [現在のブロック線図] を選択します。

  3. アウトライン ペインで、[レポート - codegen.rpt*] をクリックします。

レポートのカスタマイズ

レポートに含めるモデルとサブシステムを指定し、レポートに含めるセクションをカスタマイズします。

  1. アウトライン ペイン (左側) で、[章 - Generated Code] ノードを展開します。既定の設定では、このレポートには 2 つのセクションがあり、各セクションには 2 つのレポート コンポーネントのうちいずれかが含まれています。

  2. [1 節 — Code Generation Summary] ノードを展開します。

  3. [コード生成の概要] を選択します。プロパティ ペインに、コンポーネントのオプションが表示されます。

  4. コード生成の概要コンポーネントに対して行えるレポートのカスタマイズを確認するには、[ヘルプ] をクリックします。この例では、このコンポーネントのカスタマイズは行いません。

  5. [レポート エクスプローラー] ウィンドウで、[1 節 — Generated Code Listing] ノードを展開します。

  6. [生成されたコードのインポート] を選択します。プロパティ ペインに、コンポーネントのオプションが表示されます。

  7. 生成されたコードのインポート コンポーネントに対して行えるレポートのカスタマイズを確認するには、[ヘルプ] をクリックします。

レポートの生成

レポートのオプションを調整したら、[レポート エクスプローラー] ウィンドウで、[ファイル][レポート] をクリックしてレポートを生成します。[メッセージ リスト] ダイアログ ボックスが開き、レポートの生成中に表示されるメッセージを監視できます。また、レポートの生成時には、モデルのスナップショットも表示されます。[メッセージ リスト] ダイアログ ボックスがその他のダイアログ ボックスの下に隠れている場合があります。

レポートが完了したら、(この例では) report_ex フォルダーにあるレポート MyModelCGReport.rtf を開きます。