コードコメントの構成

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

目的	アクション
生成コードにコメントを含める	[コメントを含める]。このパラメーターを選択すると、コードに配置する 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 エスケープシーケンスに置き換えます。たとえば、コードジェネレーターは日本語の全角カタカナの文字「ア」を、エスケープシーケンス ア で置き換えます。詳細については、地域と言語の設定とコード生成を参照してください。

コード コメントの構成

関連するトピック

コードコメントの構成