本页翻译不是最新的。点击此处可查看最新英文版本。

na_0025：MATLAB 函数头

规范来源

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

子 ID 建议

  • NA-MAAB - a

  • JMAAB - 不支持

MATLAB 版本

全部

规则

子 ID a

MATLAB Function 模块应有一个描述性标头。

标头中的信息可以包括但不限于：

  • 函数名称

  • 功能描述

  • 假设和限制

  • 与先前版本相比的变更描述

  • 输入和输出列表

自定义参数

不适用

示例
%% Function Name: NA_0025_Example_Header
%
% Description: An example of a header file
%
% Assumptions: None
%
% Inputs:
%     List of input arguments
%
% $Revision: R2020a$ 
% $Author: MathWorks Advisory Board (MAB)$
% $Date: November 20, 2019$
%---------------------------------------------------------

理由

子 ID a：

  • 提高可读性、模型仿真、可测试性和工作流程。

  • 可能无法进行代码生成。

验证

无法通过模型顾问检查来验证对此建模规范的遵守情况。

上次更改

R2020a

版本历史记录

在 R2020a 中推出