Main Content

Simulink block descriptions

Insert descriptions of blocks as comments in generated code

Model Configuration Pane: Code Generation / Comments

Description

Specify whether to insert descriptions of blocks into generated code as comments.

Dependencies

  • This parameter only appears for ERT-based targets.

  • This parameter requires an Embedded Coder® license when generating code.

Settings

on (default) | off
On

Includes the following comments in the generated code for each block in the model, with the exception of virtual blocks and blocks removed due to block reduction:

  • The block name at the start of the code, regardless of whether you select Simulink block comments

  • Text specified in the Description field of each Block Properties dialog box

For information on code generator treatment of strings that are unrepresented in the character set encoding for the model, see Internationalization and Code Generation.

Off

Suppresses the generation of block name and description comments in the generated code.

Recommended Settings

ApplicationSetting
DebuggingOn
TraceabilityOn
EfficiencyNo impact
Safety precautionNo impact

Programmatic Use

Parameter: InsertBlockDesc
Type: character vector
Value: 'on' | 'off'
Default: 'on'

Version History

Introduced before R2006a

See Also

Topics