jc_0211: Usable characters for Inport blocks and Outport block

Guideline Publication

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

• Version 6.0

Sub ID Recommendations

• NA-MAAB — a, b, c, d, e, f

• JMAAB — a, b, c, d, e, f

MATLAB Versions

All

Rule

Sub ID a

Only these character types shall be used in Inport and Outport block names:

• Single-byte alphanumeric characters (a-z, A-Z, 0-9)

• Single-byte underscore (_)

Line breaks, single-byte spaces, double-byte characters, and control characters shall not be used.

Custom Parameter

Not Applicable

Example — Incorrect

Sub ID b

[Inport] and [Outport] block names shall not use numbers at the beginning.

Custom Parameter

Not Applicable

Example — Incorrect

Sub ID c

[Inport] and [Outport] block names shall not use underscores at the beginning.

Custom Parameter

Not Applicable

Example — Incorrect

Sub ID d

[Inport] and [Outport] block names shall not use underscores at the end.

Custom Parameter

Not Applicable

Example — Incorrect

Sub ID e

[Inport] and [Outport] block names shall not use consecutive underscores.

Custom Parameter

Not Applicable

Example — Incorrect

Sub ID f

[Inport] and [Outport] block names shall not consist solely of a single reserved MATLAB word.

Custom Parameter

Not Applicable

Example — Incorrect

Rationale

Sub IDs a, b:

• Deviation from the rule can make it difficult to maintain the integrity of the model and code.

Sub IDs c, e:

• Readability is impaired.

Sub IDs d:

• 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 IDs f:

• Readability is impaired.

• Deviation from the rule can cause unexpected issues.

Note

The MATLAB limit for the number of characters you can use in Inport and Outport block names is 2048.

Verification

Model Advisor check: Check port block names (Simulink Check)

Last Changed

R2020a