Main Content

jc_0771: Comment position in transition labels

Since R2020a

Guideline Publication

Control Algorithm Modeling Guidelines - Using MATLAB®, Simulink®, and Stateflow®

Sub ID Recommendations

  • NA-MAAB — a1/a2

  • JMAAB — a1/a2

MATLAB Versions

All

Rule

Sub ID a1

Comments in transition labels shall be positioned above transition conditions, condition actions, transition actions, and Stateflow events.

Custom Parameter

Not Applicable

Example — Correct

The position of the comments in the transition label is uniform.

Example — Incorrect

The position of the comments in the transition label is inconsistent.

Sub ID a2

Comments in transition labels shall be positioned below transition conditions, condition actions, transition actions, and Stateflow events.

Custom Parameter

Not Applicable

Example — Correct

The position of the comments in the transition label is uniform.

Example — Incorrect

The position of the comments in the transition label is inconsistent.

Rationale

Sub IDs a1, a2:

  • Uniform positioning of comments in transition labels clarifies to which transition condition, condition action, transition action, or Stateflow event the label corresponds.

Verification

Model Advisor check: Check position of comments in transition labels (Simulink Check)

Last Changed

R2020a

Version History

Introduced in R2020a