Main Content

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

[コンフィギュレーション パラメーター] ダイアログ ボックスで、ファイルのコメントのカスタマイズのパラメーターにアクセスできます。[設定][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__' などのマクロを使用します。

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

マクロ パラメーター: DATETIMETIMESTAMP (大文字小文字を区別)

// =======================================================
// 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 を使用します。