Main Content

Check usage of Stateflow comments

Check ID: mathworks.jmaab.jc_0738

Guideline: jc_0738: Usage of Stateflow® comments

Description

Identifies the comments that contains newline(s) or nested in the middle in Stateflow.

This check requires a Simulink® Check™ and Stateflow license.

Check Parameterization

This check contains sub-checks that correspond to the sub IDs specified in the MAB and JMAAB modeling guidelines. You can use the Model Advisor Configuration Editor to specify which sub IDs (one or multiple) to execute.

For reference, the MAB guideline sub ID(s) that are recommended for use by the NA-MAAB and JMAAB modeling standards organizations are:

  • NA-MAAB — a

  • JMAAB — a, b

Results and Recommended Actions

Guideline Sub IDConditionRecommended Action
jc_0738_a: If the action language is "C", comment nesting must not be used.On or more comments in Stateflow objects are nested.Comments in Stateflow must not be nested.
jc_0738_b: If the action language is "C", comments must not contain newline(s) in the middle.One or more comments in Stateflow objects contain newline(s) in the middle.Comments in Stateflow must not contain newline(s) in the middle.

Capabilities and Limitations

  • Runs on library models.

  • Allows exclusions of blocks and charts.

  • Analyzes content in masked subsystems. By default, the input parameter Look under masks is set to graphical.

  • Analyzes content of library-linked blocks. By default, the input parameter Follow links is set to on.