Main Content

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

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

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

コード コメントは自動生成するか、またはコードに自分で追加できます。

コード コメントには以下の使用法があります。

  • コードの可読性とトレーサビリティの強化

  • ユーザー間での情報の伝達

  • コード ベース内のコード検索の強化

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

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

自動生成されるコメント

パラメーター説明

コメントを含める (Simulink Coder)

生成されるファイルにどのコメントを入れるかを指定します。

Simulink ブロックのコメント (Simulink Coder)

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

モデルへのトレースに使用 (Embedded Coder)

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

Stateflow オブジェクトのコメント (Simulink Coder)

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

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

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

消去されたブロックを表示 (Simulink Coder)

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

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

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

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) の信号とパラメーター データ オブジェクトについて生成コードに含めるコメントが格納されたファイルを指定します。

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

パラメーター説明

コメント スタイル (Embedded Coder)

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

Polyspace コメントの挿入 (Embedded Coder)

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

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

    メモ

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

  • バーチャル ブロック、またはブロック削減のために削除されたブロックでは、コメントは生成されません。

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

  • モデル コンフィギュレーション パラメーター [既定のパラメーター動作] を [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 をコメントとして追加します。定数値は出力データ型と一致させるために型変換を必要とします。

関連するトピック