检查标准化 MATLAB Function 头的使用

R2026b

mathworks.hism.himl_0001

依赖关系: Simulink® Check™

用法: 高完整性系统建模

规范: himl_0001：标准化 MATLAB 函数头的使用

描述

此检查用于检查模型中的所有 MATLAB® 函数（包括局部函数和引用的 MATLAB 文件中的函数），以确认这些函数具有标准化的函数头。

此检查验证函数头中是否包含以下信息：

  • 函数名称

  • 函数描述

  • 输入变量描述

  • 输出变量描述

下面的示例说明如何定义函数头：

  • % 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>

Elements under review:

  • MATLAB 函数（包括局部函数和引用的 MATLAB 文件中的函数）

检查参数

使用模型顾问配置编辑器，通过指定输入参数来定义分析范围。

参数描述
头格式类型

指定函数头应遵循的结构，以保持一致性和清晰度。

默认（默认）| 自定义

  • 默认 - 默认头格式类型

  • 自定义 - 自定义头格式类型，指定为字符串。

自定义头格式

以逗号分隔的字符串指定自定义头的结构。仅当头格式类型设置为自定义时，此参数才启用。

描述、输入、输出（默认）

检查模型中引用的外部 .m 文件

指定是否对模型中外部引用的 MATLAB 文件运行检查。

on（默认）| off

跟随链接

指定是否在分析中包含库链接模块的内容。

on（默认）| off

查看封装内部

指定是否在分析中包含封装模型元素。

all（默认）| none | graphical | functional

  • all - 检查分析包含所有封装模型元素。

  • none - 检查分析排除封装模型元素。

  • graphical - 检查分析仅包含图形封装模型元素。

  • functional - 检查分析仅包含功能封装模型元素。

建议的操作和结果

查看该检查所标记的违规以及用于修复问题的建议操作。应用更改后，请保存模型并重新运行检查分析。

建模条件建议的操作
MATLAB 函数使用非标准函数头。

请考虑根据以下规范向函数添加函数头：

  • 必须为有效的 MATLAB 注释。

  • 必须紧跟函数签名。

  • 必须具有遵循指定格式的头。

功能和限制

  • 仅分析 Simulink 模型直接引用的函数

  • 允许排除模块和图

  • 分析活动和非活动变体选择项

  • 不需要进行模型编译

版本历史记录

在 R2018b 中推出

另请参阅

主题