File Comment Customization Parameters

This page describes parameters that reside in the HDL Code Generation > Global Settings > Comments tab of the Configuration Parameters dialog box.

Enable Comments

Enable or disable comments while generating HDL code.

Settings

Default: On

On: Include requirements as comments in code or code generation reports. See Requirements Comments and Hyperlinks.
Off: Do not include requirements as comments in code or code generation reports.

Include requirements in block comments

Enable or disable generation of requirements comments as comments in code or code generation reports.

Settings

Default: On

On: If the model contains requirements comments, include them as comments in code or code generation reports. See Requirements Comments and Hyperlinks.
Off: Do not include requirements as comments in code or code generation reports.

Command-Line Information

Property: RequirementComments

Type: character vector

Value: 'on' | 'off'

Default: 'on'

To set this property, use hdlset_param or makehdl. To view the property value, use hdlget_param.

Emit time/date stamp in header

Specify whether or not to include time and date information in the generated HDL file header.

Settings

Default: On

On

Include time/date stamp in the generated HDL file header.

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

Off

Omit time/date stamp in the generated HDL file header.

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

By omitting the time/date stamp in the file header, you can more easily determine if two HDL files contain identical code. You can also avoid redundant revisions of the same file when checking in HDL files to a source code management (SCM) system.

Command-Line Information

Property: DateComment

Type: character vector

Value: 'on' | 'off'

Default: 'on'

To set this property, use hdlset_param or makehdl. To view the property value, use hdlget_param.

Custom File Header Comment

Specify a custom file header comment in the generated HDL code.

Default: ''

With Custom File Header Comment, you can enter custom comments to appear as header in the generated HDL file for your design.

For example, you can specify arguments such as title, author, modified date, and so on.

// =======================================================
// Title   		: <%Title%>
// Project 		: <%Project%>
// Author  		: <%Author%>
//
// Revision 	      : $Revision$
// Date Modified	  : $Date$
// =======================================================

Command-Line Information

Property: CustomFileHeaderComment

Type: character vector

Default: ''

To set this property, use hdlset_param or makehdl. To view the property value, use hdlget_param.

Custom File Footer Comment

Specify a custom file header comment in the generated HDL code.

Default: ''

With Custom File Footer Comment, you can enter custom comments to appear as footer in the generated HDL file for your design.

For example, you can specify arguments such as revision, generated log file, revision number, and so on.

//======================================================== 
//  xxxxxx 
//======================================================== 
//  $Log$ 
//  Revision 1.2  2009/12/14 04:38:51  sxxxxxx 
//  Initial revision 
// 
//========================================================