Main Content

モデル コンフィギュレーション パラメーター: コメント

[コード生成][コメント] カテゴリには、生成コード内のコメントを設定するためのパラメーターが含まれています。これらのパラメーターには Simulink® Coder™ のライセンスが必要です。ERT ベースのターゲットで使用可能な追加のパラメーターには、Embedded Coder® のライセンスが必要です。

コード コメントは自動的に生成されるか、コードに追加することができます。

コード コメントには次のような用途があります。

  • コードの可読性とトレーサビリティを向上させる

  • ユーザー間で情報を伝達する

  • コード ベースでのコード検索を強化する

コード コメントは自動生成コメントおよびカスタム コメントに分類できます。自動生成コメントはコード生成中にソフトウェアによって自動的に生成され、カスタム コメントはユーザーが追加します。

次のコンフィギュレーション パラメーターは、[コンフィギュレーション パラメーター] ダイアログ ボックスの [コード生成][コメント] ペインにあります。

自動生成コメント

パラメーター説明

コメントを含める

生成ファイルに含まれるコメントを指定します。

Simulink ブロックのコメント

Simulink ブロックのコメントを挿入するかどうかを指定します。

Trace to model using (Embedded Coder)

Simulink ブロック、Stateflow® 要素および MATLAB® 関数ブロックのコメントの形式を指定します。

Stateflow オブジェクトのコメント

Stateflow オブジェクトのコメントを挿入するかどうかを指定します。

コメントとして MATLAB ソース コードを含める

コメントとして MATLAB ソース コードを挿入するかどうかを指定します。

消去されたブロックを表示

消去されたブロックのコメントを挿入するかどうかを指定します。

''Model default'' ストレージ クラスに対する詳細なコメント

コメントの生成を制御することにより、コードのサイズが削減されたり、コードのトレーサビリティが向上します。

Operator annotations (Embedded Coder)

Polyspace® の演算子の注釈をコメントとして生成コードに含めるかどうかを指定します。

カスタム コメント

パラメーター説明

Simulink block descriptions (Embedded Coder)

ブロックの説明をコメントとして生成コードに挿入するかどうかを指定します。

Stateflow object descriptions (Embedded Coder)

Stateflow オブジェクトの説明をコメントとして生成コードに挿入するかどうかを指定します。

Simulink data object descriptions (Embedded Coder)

Simulink データ オブジェクトの説明をコメントとして生成コードに挿入するかどうかを指定します。

Requirements in block comments (Embedded Coder)

Simulink ブロックに割り当てられた要件の説明をコメントとして生成コードに含めるかどうかを指定します。

Custom comments (MPT objects only) (Embedded Coder)

モジュール パッケージ化ツール (MPT) の信号およびパラメーターのデータ オブジェクトについてカスタム コメントを生成コードに含めるかどうかを指定します。

MATLAB user comments (Embedded Coder)

MATLAB ユーザー コメントをコメントとして含めるかどうかを指定します。

Custom comments function (Embedded Coder)

モジュール パッケージ化ツール (MPT) の信号およびパラメーターのデータ オブジェクトについて生成コードに含めるコメントを含んでいるファイルを指定します。

次のコンフィギュレーション パラメーターは [詳細設定パラメーター] の下にあります。

パラメーター説明

Comment style (Embedded Coder)

生成される C または C++ コードのコメント スタイルとして、複数行または単一行を指定します。

Insert Polyspace comments (Embedded Coder)

Polyspace ブロック注釈用のコード コメントを挿入するかどうかを指定します。

  • コード生成ソフトウェアは、カスタム ブロックの生成コードにコメントを自動的に挿入します。そのため、カスタム ブロックの関連付けられた TLC ファイルにブロック コメントを含める必要はありません。

    メモ

    既存の TLC ファイルにブロックの説明がコメントとして手動で挿入されている場合、コード生成プロセスでは、自動生成されたコメントの代わりにこれらのコメントを出力します。TLC ファイルから既存のブロック コメントを削除することを考えます。手動で挿入されたコメントは生成コード内で適切に書式設定されていない場合があり、コードからモデルへのトレーサビリティは機能しない可能性があります。

  • ブロック削減が原因で削除されたバーチャル ブロックまたはブロックに対しては、コメントは生成されません。

  • コメントが含まれるコードを生成するようにコード ジェネレーターを構成すると、コード ジェネレーターは生成されたコードのコメントにモデル パラメーター、ブロック名、信号名および Stateflow オブジェクト名のテキストを含めます。これらのテキストに、モデルの文字セット エンコードで表現できない文字が含まれている場合、コード ジェネレーターはその文字を XML エスケープ シーケンスに置き換えます。たとえば、コード ジェネレーターは日本語の全角カタカナの文字「ア」を、エスケープ シーケンス ア で置き換えます。詳細については、Internationalization and Code Generationを参照してください。

  • モデル コンフィギュレーション パラメーター [既定のパラメーター動作]Tunable に設定すると、コード ジェネレーターはブロック パラメーターおよび出力データ型の数値に応じて、生成されたコード内の数値ブロック パラメーターに関するさまざまなコメントを追加します。たとえば、コード ジェネレーターは以下を追加します。

    • 出力データ型と一致するようにブロック パラメーターの数値を型変換する必要がある場合、コメントとしての Computed Parameter

    • 型変換しなくてもブロック パラメーターの数値が出力データ型と一致する場合、コメントとしての Expression

    明示的に指定しない限り、Simulink は数値パラメーターのデータ型を double として解釈します。以下のモデルのコードを生成します。

    // Parameters (auto storage)
    struct P_test_parameter_T_ {
      real_T Constant1_Value;              // Expression: 200
                                              //  Referenced by: '<Root>/Constant1'
    
      real_T Constant2_Value;              // Computed Parameter: Constant2_Value
                                              //  Referenced by: '<Root>/Constant2'
    
      int32_T Constant3_Value;             // Computed Parameter: Constant3_Value
                                              //  Referenced by: '<Root>/Constant3'
    };

    定数値が 200 で出力データ型が double の場合、コード ジェネレーターは Expression をコメントとして追加します。Simulink は定数値のデータ型を double として解釈し、これは型変換なしで出力データ型と一致します。

    定数値が uint8(200) で出力データ型が double の場合、コード ジェネレーターは Computed Parameter をコメントとして追加します。出力データ型と一致させるには、定数値に型変換が必要です。

    定数値が 500 で出力データ型が int32 の場合、コード ジェネレーターは Computed Parameter をコメントとして追加します。出力データ型と一致させるには、定数値に型変換が必要です。

関連するトピック