10 Matlab 函数与代码风格

函数

函数,本质上是一种可复用的代码。现实生活中,有大量的工作都是重复的,变化的只是其中一小部分。

举个例子,假如要你计算 “ 1+2+3+4+5+6+7+8+9+10 ”,最简单的方法当然是直接在Matlab命令行中敲出这个式子。
这样的方法没有复用性,下次计算还需要重新输入一遍这个式子。如果,需要计算100个,1000个或更多的数字之和,就没有办法这样输入了。

显然,这是一个重复的工作,变化的只是终点(如累加到100)。一个可以复用的程序代码是只要告诉计算机终点,它就自动完成这样的累加运算。函数就能实现这样的一个功能。

还用刚才的例子:用术语 “ 参数 ” 来指代 “ 终点 ”,术语 “ 返回值 ” 指代最终的结果。生活经验告诉我们,参数与返回值都可以有多个。

现在,我们看看在Matlab中怎样实现函数(也叫声明一个函数)。还用这个例子,先把这个函数的代码写出来,然后逐条解释。

1 function result = sum ( n )
2 result = 0;
3 for i = 1:n 
4     result = result + i;
5 end
6 return;

第一行中,有一个关键字 function, 它的作用是声明这之后一直到 return 这部分的代码都是属于这个函数的代码块。

result 是这个函数要返回的值,这个函数里面,累加所得到的结果由 result 这个变量保存。

sum 是这个函数的名字,n 是函数的参数。参数的细解释起来也比较复杂,我们实用至上,把它理解成一个可复用的代码中需要变化的内容就可以了。

例如,每次都要求从1到某个数的累加和,变化的就是这个数,每次只需要告诉程序从1累加到几就可以了。这个值通过参数传递给函数。

在调用函数的时候,只需要在命令行中原样输入函数名和参数就可以(需要函数脚本在 Matlab 的工作目录下)。

当然,一个函数的返回值可以有多个,参数也可以有多个。如果一个函数的返回值有多个,则需要用中括号将返回值括起来。多个不同参数,用逗号隔开即可。

例如,将上面的函数改个功能,既能得到累加的值,也能得到累乘的结果,还可以设定从 1 到 n 的步长。显然,这里函数返回两个值,分别为累加值和累乘积。参数也有两个,分别为 n 和步长。因此,第一行就可以改写成:

function [ result_sum, result_multi ] = sum_multi ( n,step )

请注意,调用函数的时候需要原样调用。顾名思义,这是要求在调用函数的时候要按函数定义的形式调用。虽然是原样调用,但是返回值变量,我们可以自己定义。例如调用 sum_multi 函数应该在命令行中输入:

[ result1, result2 ] = sum_multi ( 10, 2 )

上一条命令的意思是,调用sum_multi函数,其中,n = 10, step = 2. 意思就是从1到10,每隔两个数字取值。得到的累加结果保存到变量 result1中,而累乘得到的结果保存到 result2 中。

那如果调用这个函数,但是不想要累加的结果,我只想要这个函数返回的累乘结果。应该怎么办?可以用~代替你不想要的返回值。这样调用方式就变成了:

[ ~, result ] = sum_multi ( 10, 2 )

可以把最后一行的 return 理解成一个标记符,它标志着函数的代码块结束。它也定义了一些变量的作用范围(也称作用域)。

在这里顺便提一下变量的作用域。

一般说来,在一个程序的脚本文件中,不允许有重复的变量名。但如果一个变量的作用范围是有限的,那么在超出这个限制的范围内,变量名就可以重复了。

这个变量的作用范围就是一个变量的作用域。它的规则也有比较复杂的情形。仍然实用至上,到目前为止,我们只需要知道,在函数中,变量的作用范围是从 function 到 return 中间。

大家可以自己尝试着将函数 sum_multi 写出来并试着用不同的方式调用它。

代码风格

有时候,自己写了一段代码,回过头再来看,发现居然看不懂了。为了交流方便,也为了方便代码维护,就要求大家遵循一定的规范,使得大家都能读懂代码。这些规则,有很多版本。这里只介绍几条核心要求:

  • 勤用注释
    注释包括程序功能、函数功能、用法的说明,也包括对变量名、关键代码行的注释。
    基本的原则是为了维护方便,也为了让别人能看明白你写的代码。
    使用 % 符号在代码中添加注释,可以在程序的任何位置中出现注释。
% 求矩阵元素中的和
function y = sum ( x ) % y是函数的返回值,返回一个整数

上例中,第一个注释是解释这个函数是干什么的。第二行里面的注释是简单说明了返回值 y 的数据类型。

  • 尽可能地将程序写得灵活,方便改动。
    这意味着写一个程序要尽可能地考虑到不同的应用场景,或者是不同的设备环境。当然,这个要求相对较高,可以在慢慢熟练以后逐渐熟悉。

  • 缩进
    虽然 matlab 没有像 python 一样强制要求缩进。但是为了读起来方便,要善用缩进让代码可读性更强。

    原文作者:花生_毛豆
    原文地址: https://www.jianshu.com/p/85b11170eac6
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞