Main Content

jc_0603: Model description

Sub ID Recommendations

  • NA-MAAB — No recommendations

  • JMAAB — a, b

MATLAB Versions

All

Rule

Sub ID a

The model layer shall include a description of the layer.

Layers that require a description are defined (by function and layer type) in the project.

Custom Parameter

Description object (block type, etc.)

Layer being described

Example — Correct

Model layer includes description [Requirement].

Sub ID b

The format of the layer description shall be consistent in the model.

Custom Parameter

Model description format

Rationale

Sub ID a:

  • When a description is not included, the readability of the control specifications is reduced. Usability, maintainability, and portability also decreases.

Sub ID b:

  • Readability is impaired when the description format is not consistent.

Verification

Model Advisor check: Check Model Description (Simulink Check)

Last Changed

R2020a

See Also

Introduced in R2020a