为了查看方便,本文复制于:https://blog.csdn.net/qq_15971883/article/details/82884353?depth_1-utm_source=distribute.pc_relevant.none-task&utm_source=distribute.pc_relevant.none-task。
本文介绍如何规范地编写一个函数文件。
通常,函数文件由函数声明行、H1行、在线帮助文本区、编写和修改记录、函数主体等几个部分组成。格式如下:
function 输出形参表 = 函数名(输入形参表)
在线帮助文本区,其中第一行为H1行
编写和修改记录
函数主体
函数声明行
由关键字function引导,指明这是一个函数文件,并定义函数名、输入参数和输出参数。
函数名应当与文件名一致(保存函数文件时会默认以函数名作为文件名予以保存),如果两者不一致,MATLAB将以文件名为准,以后调用时使用文件名调用该函数。
在脚本文件中编写函数时,需以end结尾;独立的函数文件不需以end结尾。
MATLAB中的函数文件名必须以字母开头,可以是字母、下划线、数字的任意组合,但不可以超过31个字符。
H1行
紧随函数声明行之后的以“%”开头的第一注释行。
H1行包括大写的函数名和函数功能简要描述,采用lookfor命令可在命令行窗口显示H1行的信息。
建议在编写H1注释行时,尽量采用英文表述,这是为了之后的使用过程中关键词检索的方便。
在线帮助文本区
包括H1行以及H1行之后的连续的以“%”开头的注释行。
通常包括函数输入变量和输出变量的含义以及调用说明。
采用help命令可在命令行窗口显示在线帮助文本区的信息。
编写和修改记录
与在线帮助文本区以一个空行相隔。
该行以“%”开头,记录了编写及修改函数文件的作者、日期、版本等内容,以方便后来的使用查询或修改。
函数主体
应与编写和修改记录以一个空行相隔。
这部分内容包括了所有实现该函数文件功能的MATLAB指令。
范例:
function spir_len = spirallength(d, n, lcolor)
% SPIRALLENGTH plot a circle of radius as r in the provided color and calculate its area