@zouchenye
- 以小写字母开头的英文单词命名,若变量由多个单词组成,使用大写分割,如:qualityOfLife
- 减少变量名中下划线的使用,避免在某些情况下matlab识别为下标
- 表示数量时,以n开头命名变量,如:nFiles
- 第3条的特例,由于matlab中矩阵一般为m*n,所以可用mRows代表行数
- 考虑到matlab中有时使用i,j作为复数的表示,因此循环变量可以选择如iFiles等方式命名
- 常量全部大写,多个单词间使用下划线分开,如:COLOR_RED
- 使用新的变量名前检查工作区中别的m文件是否已经使用过该变量名,避免程序出现bug
- 只有一个返回值的函数的用它的返回值含义命名,如:mean()
- 没有返回值的函数用它具体做的事情命名,如:plot()
- 返回值是布尔值的函数用is作为前缀
- 缩进规范
- 代码模块化,将一些经常使用的代码部分封装成函数
- 如果一个函数只被一个m文件里的函数调用,不必封装成单独的m文件
- input和output与计算部分的模块分开,output部分需要简洁易懂
- 想要实现某一功能时,先查阅官方文档,寻找有没有现成的函数可以调用。以此减少重复劳动,提高代码效率
- m文件开头注明程序或函数实现的功能
- m文件开头注明一些可能的报错和解决方法
- 如果变量是数组,注明数组各维度含义
- simulink的参数文件写清各参数的含义
- 如果参数的值可以调整,注明建议调整的范围
- 将模型中需要的所有参数写在一个m文件中,方便修改
- 连线整齐,模块布局合理
- 建模模块化,将实现一些特定功能的部件封装成子模块
- 保留一些建模中间变量的观察窗口,方便运行时观察结果是否正确
http://www.datatool.com/downloads/matlab_style_guidelines.pdf