jc_0801: Prohibited use of the /* and */ comment symbols

Guideline Publication

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

Version 6.0

Sub ID Recommendations

NA-MAAB — a
JMAAB — a

MATLAB Versions

All

Rule

Sub ID a

As comment symbols /* and */ are automatically assigned in the generated code, the symbol shall not be used in:

Code Generate Templates (.cgt) files
mpt.Signal description
mpt.Parameter description

Custom Parameter

Not Applicable

Example — Incorrect

Included in a .cgt file.

Included in the mpt.Signal description.

Rationale

Sub ID a:

Since comment symbols /* and */ are automatically assigned in the generated code, comments can be unintentionally nested and behave differently than expected.

Verification

Model Advisor check: Check for use of C-style comment symbols (Simulink Check)

Last Changed

R2020a

See Also

Code Generation Template (CGT) Files (Embedded Coder)
MPT Data Object Properties (Embedded Coder)
Specify Comment Style for C/C++ Code (Embedded Coder)
Add Custom Comments for Variables in the Generated Code (Embedded Coder)

Version History

Introduced in R2020a