Main Content

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

以下の節では、HDL Coder™ を使用して、生成されたコードにテキストの注釈を追加する方法を説明します。この注釈には、モデルの注釈、テキスト コメント、要件コメントの形式があります。

Simulink の注釈

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

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

注釈に関する一般的な情報は、メモと注釈を使用したモデルの説明を参照してください。

信号の説明

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

テキスト コメント

DocBlock を目的のレベルに配置してテキスト コメントを入力することで、テキスト コメントをモデルの任意のレベルに入力できます。HDL Coder は、DocBlock のテキストを生成されたコード内にプレーン テキストのコメントとして描画します。コメントは、モデルの階層構造内で DocBlock を含むサブシステムと同じレベルに生成されます。

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

DocBlock に関する一般的な情報は、DocBlockを参照してください。

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

要件コメントをブロックに割り当てることができます。

モデルに要件コメントが含まれている場合、次のいずれかの形式でコメントを表示するように選択できます。

  • 生成されたコード内のテキスト コメント: 要件をコード内にテキスト コメントとして含めるには、[コンフィギュレーション パラメーター] ダイアログ ボックスで、既定の設定の [ブロック コメントに要件を含める] (オン) と [トレーサビリティ レポートの生成] (オフ) を使用します。

    コマンド ラインからコードを生成する場合は、Traceability および RequirementComments プロパティを設定します。次のコードは、mcombo モデルの Gain ブロックに対して生成されたテキスト要件コメントを示しています。

    open_system('mcombo')
    makehdl(gcb,'Traceability','off','RequirementComments','on');
    
        BEGIN
          In1_signed <= signed(In1);
    
          --
          -- Block requirements for <S10>/Gain
          -- 1. Gain Requirements Sect 1
          -- 2. Gain Requirements Sect 2
          Gain_gainparam <= to_signed(16384, 16);
    
          Gain_out1 <= resize(In1_signed(15 DOWNTO 0) & '0'
    
          Out1 <= std_logic_vector(Gain_out1);
    
        END rtl;
    
  • ハイパーリンク コメント: 要件コメントを HTML コード生成レポートにハイパーリンク コメントとして含めるには、[コンフィギュレーション パラメーター] ダイアログ ボックスの [トレーサビリティ レポートの生成] および [ブロック コメントに要件を含める] を選択します。

    コマンド ラインからコードを生成する場合は、Traceability および RequirementComments プロパティを次のように設定します。

    makehdl(gcb,'Traceability','on','RequirementComments','on');
    

    コメントには、ブロックに関連付けられた要件ドキュメントおよび元のモデル内のブロックに戻るリンクが含まれています。たとえば、次の図は Gain ブロックに関連付けられた 2 つの要件リンクを示しています。これらのリンクはテキスト要件ファイルのセクションを指します。

次のコードは、Gain ブロックについて生成されたハイパーリンク付きの要件コメントを示しています。

    BEGIN
      In1_signed <= signed(In1);

      -- <S10>/Gain
      --
      --
      -- Block requirements for <S10>/Gain
      -- 1. Gain Requirements Sect 1
      -- 2. Gain Requirements Sect 2
      Gain_gainparam <= to_signed(16384, 16);

      Gain_out1 <= resize(In1_signed(15 DOWNTO 0) & '0'

      Out1 <= std_logic_vector(Gain_out1);

    END rtl;