注釈またはコメント付きのコードの生成

HDL Coder™ ソフトウェアを使用して、生成されたコードにテキストの注釈を追加できます。この注釈には、モデルの注釈、テキストコメント、要件コメントの形式があります。

Simulink の注釈

テキストを Simulink^® の注釈としてブロック線図に直接入力すると、HDL Coder は、その Simulink の注釈のテキストを生成されたコードでプレーンテキストのコメントとしてレンダリングします。コメントは、モデルの階層構造内で注釈を含むサブシステムと同じレベルに生成されます。

Constant ブロックの場合、注釈を HDL コードのコメントとして反映するには、[中間信号を最小にする] チェックボックスをオフにして、[トレーサビリティスタイル] を [Comment Based] に設定します。

注釈の詳細については、Annotate Modelsを参照してください。

信号の説明

Simulink モデル内の信号の説明を指定すると、生成された HDL コードでは、その説明が信号宣言ステートメントの上にコメントとして表示されます。信号の説明を指定するには、信号を右クリックして [プロパティ] を選択し、[信号プロパティ] ダイアログボックスを開きます。次に、[ドキュメンテーション] タブを選択し、[説明] セクションに信号の説明を入力します。信号の説明では、ASCII 文字を使用します。生成されたコードに非 ASCII 文字があると、下流の合成ツールや lint ツールの妨げになる可能性があります。場合によっては、信号に対して行われる最適化により、生成されたコードでは一部の信号の説明が HDL コメントに変換されないか、特定の信号について説明する HDL コメントの複製が作成されることがあります。

テキストコメント

DocBlock ブロックを使用してテキストコメントを入力することでモデル内にテキストコメントを入力すると、HDL Coder は、DocBlock ブロックのテキストを生成されたコードでプレーンテキストのコメントとしてレンダリングします。コメントは、モデルの階層構造内で DocBlock ブロックを含むサブシステムと同じレベルに生成されます。

DocBlock の [ドキュメントタイプ] パラメーターを [テキスト] に設定します。HDL Coder は、[HTML] や [RTF] のオプションをサポートしません。

DocBlock ブロックの詳細については、DocBlockを参照してください。

要件コメントおよびハイパーリンク

Requirements Toolbox™ を使用することで、要件をブロックに割り当て、生成コードでその要件をコメントとして生成できます。以下に例を示します。

以下のコマンドを使用してモデル hdlcoder_simple_up_counter を開きます。
```
openExample("hdlcoder_simple_up_counter");
```
要件エディター (Requirements Toolbox)を使用して、以下の詳細を指定して Delay_requirements.slreqx という名前の新しい要件セットを作成します。
- カスタム ID: 1
- 概要: Requirement 1
- 説明: Sample text 1
同様に、以下の詳細を指定して別の要件を作成します。
- カスタム ID: 2
- 概要: Requirement 2
- 説明: Sample text 2
詳細については、MATLAB または Simulink での要件の作成 (Requirements Toolbox)を参照してください。
HDL_DUT サブシステムを開きます。
Delay という名前の Delay ブロックを右クリックします。コンテキストメニューから、[要件] 、 [[外向きリンク] ダイアログを開く] を選択します。
ブロックの要件をリンクします。[新規] ボタンをクリックします。[説明]、[ドキュメントタイプ]、[ドキュメント]、および [場所 (タイプ/識別子)] の各プロパティを使用して要件に関する詳細を入力します。
[適用] および [OK] をクリックします。
生成されたコードにハイパーリンクコメントとして要件を含めるには、[コンフィギュレーションパラメーター] ダイアログボックスで以下のモデルコンフィギュレーションパラメーターを選択します。
- トレーサビリティレポートの生成
- ブロックコメントに要件を含める
あるいは、コマンドラインからコードを生成する場合は、Traceability および RequirementComments プロパティを設定します。
```
makehdl("HDL_DUT","Traceability","on","RequirementComments","on");
```
生成されたコードでは、要件は hdlcoder_simple_up_counter モデル内の Delay ブロックのコメントとして表示されます。コメントには、ブロックに関連付けられた要件へのリンクおよび元のモデル内の要件へのリンクが含まれています。
```
  -- <S1>/Delay
  -- Block requirements for <S1>/Delay
  --  1. Requirements 1
  --  2. Requirements 2
  Delay_process : PROCESS (clk, reset)
  BEGIN
    IF reset = '1' THEN
      Delay_out1 <= to_unsigned(16#00#, 8);
    ELSIF clk'EVENT AND clk = '1' THEN
      IF enb = '1' THEN
        Delay_out1 <= Switch1_out1;
      END IF;
    END IF;
  END PROCESS Delay_process;
```