ファイルのコメントのカスタマイズのパラメーター

このページは前リリースの情報です。該当の英語のページはこのリリースで削除されています。

[コンフィギュレーションパラメーター] ダイアログボックスで、ファイルのコメントのカスタマイズのパラメーターにアクセスできます。[設定] 、 [HDL コード生成] 、 [グローバル設定] 、 [コメント] タブを選択します。

コメントを有効にする

HDL コードの生成中に、コメントを有効または無効にします。

設定

既定の設定: オン

オン: コードまたはコード生成レポートには、要件をコメントとして含めます。要件コメントおよびハイパーリンクを参照してください。
オフ: コードまたはコード生成レポートには、要件をコメントとして含めません。

ブロックコメントに要件を含める

コード内のコメントまたはコード生成レポートで要件コメントの生成を有効または無効にします。

設定

既定の設定: オン

オン: コードまたはコード生成レポートには、要件をコメントとして含めます。要件コメントおよびハイパーリンクを参照してください。
オフ: コードまたはコード生成レポートには、要件をコメントとして含めません。

コマンドライン情報

プロパティ: RequirementComments

型: 文字ベクトル

値: 'on' | 'off'

既定の設定: 'on'

このプロパティを設定するには、関数 hdlset_param または makehdl を使用します。プロパティの値を表示するには、関数 hdlget_param を使用します。

ヘッダーに時間/日付スタンプを出力

生成された HDL ファイルヘッダーに時刻と日付の情報を含めるかどうかを指定します。

設定

既定の設定: オン

オン

生成された HDL ファイルヘッダーに日時スタンプを含めます。

 -- ----------------------------------------------------
 -- 
 -- File Name: hdlsrc\symmetric_fir.vhd
 -- Created: 2011-02-14 07:21:36
 --

オフ

生成された HDL ファイルヘッダーから日時スタンプを省略します。

 -- ----------------------------------------------------
 -- 
 -- File Name: hdlsrc\symmetric_fir.vhd
 --

ファイルヘッダーから日時スタンプを省略することで、2 つの HDL ファイルに同一のコードが含まれているかどうかを容易に判別できるようになります。また、HDL ファイルをソースコード管理 (SCM) システムへチェックインする場合に、同一のファイルが重複してリビジョンされるのを回避できます。

コマンドライン情報

プロパティ: DateComment

型: 文字ベクトル

値: 'on' | 'off'

既定の設定: 'on'

このプロパティを設定するには、関数 hdlset_param または makehdl を使用します。プロパティの値を表示するには、関数 hdlget_param を使用します。

依存関係

このオプションを使用するには、[カスタムファイルのヘッダーコメント] テキストボックスを空にする必要があります。カスタムのファイルヘッダーコメントを使用する際は、生成された HDL コードに日時を追加するための日時スタンプマクロを使用します。

メモ

[カスタムファイルのヘッダーコメント] テキストボックスをクリアした後、[コンフィギュレーションパラメーター] ダイアログボックスを再度開いて適用された変更を確認します。

カスタムファイルのヘッダーコメント

生成された HDL コードに、カスタムのファイルヘッダーコメントを指定します。

既定の設定: '' (Empty)

[カスタムファイルのヘッダーコメント] では、設計で生成される HDL ファイルのヘッダーとして出力されるカスタムコメントを入力できます。

タイトル、作成者、更新日などの引数を指定できます。

生成された HDL ファイルに日付、時刻、タイムスタンプ、モデル名、モデルバージョン、ファイル名などの引数を含めるには、[カスタムファイルのヘッダーコメント] で以下のマクロを使用します。

引数	マクロの構文
日付	`__DATE__`
時刻	`__TIME__`
タイムスタンプ	`__TIMESTAMP__`
モデルバージョン	`__MODELVERSION__`
モデルの名前	`__MODELNAME__`
ファイル名	`__FILENAME__`

マクロ構文: __<Parameter>__ (パラメーターの先頭と末尾に 2 つのアンダースコアを付ける)

// =======================================================
// Project: Your_Project_Title
// Author: Author_Name
//
// Date: __DATE__
// Time: __TIME__
// Timestamp: __TIMESTAMP__
// =======================================================

ヘッダーコメントを確認するには、HDL コードを生成してから、生成された HDL ファイルを開きます。生成された HDL コードに、カスタムのファイルヘッダーコメントが追加されます。

// =======================================================
// Project: Your_Project_Title
// Author: Author_Name
//
// Date: 11-05-2021
// Time: 05:20:58
// Timestamp: 11-05-2021 05:20:58
// =======================================================

コマンドライン情報

プロパティ: CustomFileHeaderComment

型: 文字ベクトル

既定の設定: ''

このプロパティを設定するには、関数 hdlset_param または makehdl を使用します。プロパティの値を表示するには、関数 hdlget_param を使用します。

たとえば、マクロを使用してカスタムのファイルヘッダーコメントに日付、時刻、およびタイムスタンプを含めるには、関数 hdlset_param を使用してモデルにパラメーターを設定してから、HDL コードを生成します。

hdlset_param('sfir_fixed', 'CustomFileHeaderComment', ...
     'Created: __DATE__; __TIME__; __TIMESTAMP__');

カスタムファイルのフッターコメント

生成された HDL コードに、カスタムのファイルフッターコメントを指定します。

既定の設定: ''(Empty)

[カスタムファイルのフッターコメント] では、設計で生成される HDL ファイルのフッターとして出力されるカスタムコメントを入力できます。

たとえば、リビジョン、生成されたログファイル、リビジョン番号などの引数を指定できます。

//======================================================== 
//  xxxxxx 
//======================================================== 
//  Log 
//  Revision 1.2  __TIMESTAMP__   
//  Initial revision 
// 
//========================================================

生成された HDL コードに日付、時刻、およびタイムスタンプを含めるには、カスタムのファイルフッターコメントで '__DATE__'、'__TIME__'、'__TIMESTAMP__' などのマクロを使用します。フッターコメントを確認するには、HDL コードを生成してから、生成された HDL ファイルを開きます。

//======================================================== 
//  xxxxxx 
//======================================================== 
//  Log 
//  Revision 1.2  11-05-2021 05:20:58  
//  Initial revision 
// 
//========================================================

コマンドライン情報

プロパティ: CustomFileFooterComment

型: 文字ベクトル

既定の設定: ''

このプロパティを設定するには、関数 hdlset_param または makehdl を使用します。プロパティの値を表示するには、関数 hdlget_param を使用します。