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

[コード生成] 、 [コメント] カテゴリには、生成コード内のコメントを設定するためのパラメーターが含まれています。これらのパラメーターには 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 ユーザーコメント (Embedded Coder)	MATLAB ユーザーコメントをコメントとして含めるかどうかを指定します。
Custom comments function (Embedded Coder)	モジュールパッケージ化ツール (MPT) の信号およびパラメーターのデータオブジェクトについて生成コードに含めるコメントを含んでいるファイルを指定します。

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

パラメーター	説明
コメントスタイル (Embedded Coder)	生成される C または C++ コードのコメントスタイルとして、複数行または単一行を指定します。
Polyspace コメントの挿入 (Embedded Coder)	Polyspace ブロック注釈用のコードコメントを挿入するかどうかを指定します。

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

メモ
既存の TLC ファイルにブロックの説明がコメントとして手動で挿入されている場合、コード生成プロセスでは、自動生成されたコメントの代わりにこれらのコメントを出力します。TLC ファイルから既存のブロックコメントを削除することを考えます。手動で挿入されたコメントは生成コード内で適切に書式設定されていない場合があり、コードからモデルへのトレーサビリティは機能しない可能性があります。
ブロック削減が原因で削除されたバーチャルブロックまたはブロックに対しては、コメントは生成されません。
コメントが含まれるコードを生成するようにコードジェネレーターを構成すると、コードジェネレーターは生成されたコードのコメントにモデルパラメーター、ブロック名、信号名および Stateflow オブジェクト名のテキストを含めます。これらのテキストに、モデルの文字セットエンコードで表現できない文字が含まれている場合、コードジェネレーターはその文字を XML エスケープシーケンスに置き換えます。たとえば、コードジェネレーターは日本語の全角カタカナの文字「ア」を、エスケープシーケンス ア で置き換えます。詳細については、地域と言語の設定とコード生成を参照してください。
モデルコンフィギュレーションパラメーター [既定のパラメーター動作] を 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 をコメントとして追加します。出力データ型と一致させるには、定数値に型変換が必要です。

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

自動生成コメント

カスタム コメント

関連するトピック

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

カスタムコメント