Simulink data object descriptions
Include descriptions of Simulink data objects as comments in generated code
Model Configuration Pane: Code Generation / Comments
Description
Specify whether to insert descriptions of Simulink® data objects into generated code as comments.
This parameter applies to only data objects that have a storage class that has exported scope.
This parameter does not affect
Simulink.LookupTable
or Simulink.Breakpoint
objects that you configure to appear in the generated
code as a structure (for example, by storing all of
the table and breakpoint data in a single Simulink.LookupTable
object).
Dependencies
This parameter appears for only ERT-based targets.
This parameter requires an Embedded Coder® license when you generate code.
Settings
on
(default) | off
- On
Inserts contents of the Description field in the Model Explorer Object Properties pane for each Simulink data object (signal, parameter, and bus objects) in the generated code as comments.
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 data object property descriptions as comments in the generated code.
Recommended Settings
Application | Setting |
---|---|
Debugging | On |
Traceability | On |
Efficiency | Noimpact |
Safety precaution | Noimpact |
Programmatic Use
Parameter: SimulinkDataObjDesc |
Type: character vector |
Value: 'on' | 'off' |
Default: 'on' |
Version History
Introduced before R2006a