检查函数头
检查 ID:mathworks.jmaab_v6.mp_0032
规范:mp_0032:使用函数头的方法
描述
检查函数头是否包含输入参数指定的描述项。
此检查适用于以下目标组件:
Simulink® 中的 MATLAB Function 模块。
Stateflow® 图中的 MATLAB® 函数。
模型中引用的外部 MATLAB 文件。
此检查需要 Simulink Check™ 许可证。
检查参数化
此检查不包括子检查,因为 JMAAB 建模规范仅提供一个子 ID。
作为参考,JMAAB 建模标准组织建议使用的规范子 ID 为:
JMAAB - a
选择检查模型中引用的外部 .m 文件,以在分析中包括扩展名为 .m
的文件。默认情况下,该复选框处于选中状态。
在描述性项目框中,用竖线符号 ("|") 分隔,输入要检查的函数头的描述项。描述性不区分大小写,可以在函数头中以任意顺序出现。默认值为 Overview|Processing content|Arguments|Return value|change history
。
函数头中的每个描述项必须位于单独的一行,且不能包含特殊字符。例如,输入参数描述性项目取默认值,检查不会将以下函数头标记为存在潜在问题。
% Overview % sample program % Processing content % Add arg1 and foo and return the value % Arguments % arg1: First term % Return Value % ret: Addition result % Change History % 05/24/2022 - added new comments
描述性项目取默认值时,检查会将以下函数头标记为存在潜在问题:
% Overview -- % sample program % Processing content Add arg1 and foo and return the value % Arguments arg1: First term % Return Value % ret: Addition result % Change History ! % 05/24/2022 - added new comments
结果和建议的操作
条件 | 建议的操作 |
---|---|
一个或多个函数头未包含指定的描述项。 | 在函数头中包含由输入参数描述性项目指定的描述项。 |
功能和限制
可以分析库链接模块的内容。默认情况下,输入参数 Follow links 设置为 on。
可以分析封装子系统中的内容。默认情况下,输入参数 Look under masks 设置为 all。
对库模型运行。
允许排除模块和图。