jc_0232: Usable characters for parameter names

Guideline Publication

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

• Version 6.0

Sub ID Recommendations

• NA-MAAB — a, b, c

• JMAAB — a, b, c

MATLAB Versions

All

Rule

Sub ID a

The parameter name shall not use underscores at the end.

Custom Parameter

Not Applicable

Sub ID b

The parameter name shall not use consecutive underscores.

Custom Parameter

Not Applicable

Sub ID c

The parameter name shall not consist solely of a single reserved MATLAB word.

Custom Parameter

Not Applicable

Rationale

Sub ID a:

• Readability is impaired.

• Underscores can be used to separate words. However, they are typically used as word breaks and can cause misunderstanding in the description.

Sub ID b:

• Readability is impaired.

Sub ID c:

• Readability is impaired. Deviation from the rule can cause unexpected issues.

Note

The MATLAB limit for the number of characters you can use in parameter names is 2048.

Verification

Model Advisor check: Check usable characters for parameter names (Simulink Check)

Last Changed

R2024b