Check usage of standardized MATLAB function headers

mathworks.hism.himl_0001

Dependencies: Simulink® Check™

Usage: High-Integrity System Modeling

Guideline: himl_0001: Usage of standardized MATLAB function headers

Description

Use this check to inspect all MATLAB® functions in the model, including local functions and functions in referenced MATLAB files, to check that they have standardized function headers.

This check verifies the presence of this information in the function header:

  • Function name

  • Function description

  • Description of input variables

  • Description of output variables

Here is an example of how to define function headers:

  • % FUNCTION NAME:<Description of the function>

  • % Input variable 1: < Description of input variable 1>

  • % Input variable 2: < Description of input variable 2>

  • % Output variable 1: < Description of output variable 1>

Check Parameters

Use the Model Advisor Configuration Editor to define the scope of the analysis by specifying the input parameters.

ParameterDescription
Header format type

Specify the structure that function headers should follow to maintain consistency and clarity.

Default (default) | Custom

  • Default — Default header format type

  • Custom — Custom header format type to be specified as a string.

Custom header format

Specify the structure of custom header in a in a comma-separated string. This parameter is enabled only when Header format type is set to Custom.

Description, Input, Output (default)

Check external .m files referenced in the model

Specify whether to run on externally referenced MATLAB files in the model.

on (default) | off

Follow links

Specify whether to include content of library-linked blocks in the analysis.

on (default) | off

Look under masks

Specify whether to include masked model elements in the analysis.

all (default) | none | graphical | functional

  • all — Check analysis includes all masked model elements.

  • none — Check analysis excludes masked model elements.

  • graphical — Check analysis includes only the graphical masked model elements.

  • functional — Check analysis includes only the functional masked model elements.

Recommended Actions and Results

Review the violations that are flagged by the check and the recommended action for fixing the issue. After applying the changes, save the model and rerun the check analysis.

Modeling ConditionRecommended Action
MATLAB functions use nonstandard function headers.

Consider adding a function header to the functions according to these guidelines:

  • Must be a valid MATLAB comment.

  • Must immediately follow the function signature.

  • Must have the header according to specified format.

Capabilities and Limitations

  • Analyzes only the functions that are directly referenced by the Simulink model

  • Allows exclusions of blocks and charts

  • Analyzes both active and inactive variant choices

  • Does not require model compilation

Version History

Introduced in R2018b

See Also

Topics