【代码规范】MATLAB的代码书写规范和维护

自己在科研中使用MATLAB非常多，但是在代码编写时不注意代码规范，一段时间后就会忘记，自己都不懂，所以参考网上和自己踩过的坑来记录下一些好的经验。

1、命名规范

• 变量命名用英文，比如windSpeed代表风速；
• 英文混用大小写，tiffFormat；
• 变量名命名要有意义；
• 对数值对象用前缀n进行声明，如nRows；
• 变量单复数表示，利用apple和appleArray;
• 代表单个实体数据的变量可以加以后缀No或者是前缀i
• 循环变量应该以i,j,k为前缀;

2、常数命名

• 采用大写字母，MAX_ITERATIONS
• 参数可以以某些通用类型名作为前缀，COLOR_RED

3、函数命名

• 使用小写单词进行命名；
• 尽量长、有意义；采用： computetotalwidth（）避免： compwid（）
• 单输出变量的函数可以根据输出参数命名；
• 没有输出变量或者返回值为句柄的函数应该根据其实现的功能命名；Ps.这一点应该注意
• 前缀 compute应该用在计算某些量的函数的地方例如：ComputWeightedAverage()
• 前缀find可以用在那些具有查询功能的函数的地方例如：FindOldestRecord(.);FindHeaviestElement(.);
• 避免缩写采用：ComputeArrivalTime(.)避免：CompArr(.).

4、m文件

• 函数模块化编写
• 编写好测试脚本