Main Content

コード コメントの構成

コード ジェネレーターで生成コードにコメントを挿入する方法は、[コード生成]、[コメント] ペインでパラメーターを変更することによって構成します。

目的アクション

生成コードにコメントを含める

[コメントを含める]。このパラメーターを選択すると、コードに配置する 1 つ以上の自動生成コメントの種類を選択できます。

Simulink ブロックのコードを説明するコメントを含める

[Simulink ブロックのコメント]。このパラメーターを選択すると、生成コード内の Simulink® ブロックのコードの前にコメントが挿入されます。Embedded Coder® で、[モデルへのトレースに使用] (Embedded Coder) を使用してコメント形式として [ブロック パス] または [Simulink 識別子] を選択します。

Stateflow オブジェクトを説明するコメントを含める

[Stateflow オブジェクトのコメント]。このパラメーターを選択すると、生成コード内に Stateflow® オブジェクトを説明するコメントが挿入されます。Embedded Coder で、[モデルへのトレースに使用] (Embedded Coder) を使用してコメント形式として [ブロック パス] または [Simulink 識別子] を選択します。

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

[コメントとして MATLAB ソース コードを含める]。このパラメーターを選択すると、関連する生成コードの前にコメントが挿入されます。この関数シグネチャは関数バナーに含まれます。

消去されたブロックについてのコメントを含める

[消去されたブロックを表示]。このパラメーターを選択すると、インライン パラメーターなど、最適化の結果として消去されたブロックについてのコメントが挿入されます。

パラメーターの数にかかわらずパラメーターのコメントを含める

[''Model default'' ストレージ クラスに対する詳細なコメント]。このパラメーターを選択すると、model_prm.h にモデル パラメーター構造体宣言のパラメーター変数名とソース ブロック名についてのコメントが挿入されます。

このパラメーターを選択しないと、宣言されたパラメーターが 1000 個未満の場合にパラメーターのコメントが生成されます。これにより、多数のパラメーターをもつモデルに対して生成されるファイルのサイズが抑えられます。

MATLAB ユーザー コメントを含める

[MATLAB ユーザー コメント] (Embedded Coder)。このパラメーターを選択すると、MATLAB® コードからの関数の説明コメントやその他のユーザー コメントが生成コード内のコメントとして挿入されます。

コメント スタイルを指定する

[コメント スタイル] (Embedded Coder)。生成コード内のコメントのスタイルとして Auto、Multi-line または Single-line を選択します。

メモ:

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

関連するトピック