生成されるコードにコ​メントを入れるにはど​うすればよいですか？

生成されるコードにコメントを入れる方法を教えてください。

Answer 1

[MathWorks Support Team]

Real-Time Workshop Embedded Coderの機能を使用すると、生成されるコードにコメントを入れることができます。

具体的には、コンフィギュレーションパラメータから「Real-Time Workshop」->「テンプレート」を選択し、コードテンプレート、データテンプレートに設定されているCGTファイルを編集します。

例えば、このファイルの先頭や末尾にコメントを追加すると、生成コードの先頭と末尾にコメントが追加されます。

また、ビルトイントークンという下記の記述の前後にコメントを入れると、生成コードの前後にコメントが追加されます。

ビルトイントークン : 生成コード

-------------------------------------

%<Includes> : #include文

%<Defines> : #define文

%<Types> : typedef

%<Enums> : 列挙体

%<Definitions> : データ定義(例 double x = 3.0;)

%<Declarations>: データ宣言(例 extern double x;)

%<Functions> : step関数、initialize関数、terminate関数

また、Docブロックと注釈をコメントとして表示するには、下記設定後にコード生成を行います。

・Docブロック

1. Docブロックを右クリックし、「マスクパラメータ」を選択します。

2. RTW Embedded Coder Flagに下記のいずれかを入力し、OKボタンをクリックします。

Abstract, Description, History, ModifiedHistory, Notes

・注釈

注釈の前に S:Symbol_name という記述を入れます。

Symbol_nameの部分は下記のいずれかになります。

Description, History, ModifiedHistory, Notes

詳細については下記ドキュメントを参照してください。

Real-Time Workshop Embedded Coder

　->User Guide

　　->Preparing Models for Code Generation

　　　->Specifying Code Appearance and Documentation

　　　　->Customizing Comments in Generated Code

　　　　　->Configuring Templates for Customizing Code Organization and Format

また、ブロックやオブジェクトの「説明」に記述した内容を出力することもできます。

ブロックを右クリックしてプロパティを選択して開く画面の「説明」に記述した内容がコード生成時にコメントとして出力されます。Parameterオブジェクトや信号オブジェクトでもブロックプロパティ同様に「説明」の箇所があり、こちらもコメントとして出力可能です。

その際、コンフィギュレーションパラメーターの「コード生成」→「コメント」ペインで「Simulink ブロックの説明」と「Simulink データ オブジェクトの説明」にチェックを入れておきます。

次のコマンドを実行して開くデモモデルでもコメントの追加方法の例を確認できます。

rtwdemo_comments