mp_0032：函数头信息

自 R2024b 起

规范来源

控制算法建模规范 - 使用 MATLAB®、Simulink® 和 Stateflow®

子 ID 建议

  • JMAAB - a

MATLAB 版本

全部

规则

子 ID a

应在函数头中描述必要的信息。

补充信息

描述项可以包括概述、处理细节、输入和输出参量、管理信息和其他相关信息。描述项的组合应根据需要针对主要功能和子功能进行调整。

示例 - 正确
function ret = sample(arg1)
% Overview
% sample program
% Processing details
% Adds arg1 and foo and returns the value
% Arguments
% arg1 : First term
% Return Value
% ret : Result of addition
% Change History
% -------------------------------
% 2018/3/14 Created
% -------------------------------
% 2018/3/30 Added comments

foo = 3;
ret = arg1 + foo;
end
自定义参数

函数头的描述项。

理由

子 ID a：

  • 通过明确指定要共享的信息，可以提高可读性和可维护性。

验证

模型顾问检查：检查函数头 (Simulink Check)

上次更改

R2024b

版本历史记录

在 R2024b 中推出