[精] Matlab M文件的编程规范

部分来自：杨高波 等《精通MATLAB 7.0 混合编程》

(1) 函数名和文件名必须相同；

(2) 命名应该能够反映它们的意义或者用途；

部分来自：林锐《高质量C++/C编程指南》

　　变量名和参数名应当使用“名词”或者“形容词＋名词”，用小写字母开头的单词组合而成

　　　　例如：

　　　　float  value;

　　　　float  oldValue;

　　　　float  newValue;

　　　　BOOL flag;

　　　　int  drawMode;

　　类名和函数名应当使用“动词”或者“动词＋名词”（动宾词组），用大写字母开头的单词组合而成

　　　　例如：

　　　　DrawBox();　　// 全局函数

　　　　class Node;　　// 类名

　　　　class LeafNode;　　　　// 类名

　　　　void  Draw(void);　　　 // 函数名

　　　　void  SetValue(int value);　　// 函数名

　　类的成员函数应当只使用“动词”，被省略掉的名词就是对象本身

　　　　例如：

　　　　Box->Draw();        // 类的成员函数

　　常量全用大写的字母，用下划线分割单词。

　　　　例如：

　　　　const int MAX = 100;

　　　　const int MAX_LENGTH = 100;

　　静态变量加前缀s_（表示static）

　　　　例如：

　　　　static int s_initValue;　　// 静态变量

　　如果不得已需要全局变量，则使全局变量加前缀g_（表示global）。

　　　　例如：

　　　　int g_howManyPeople;　  // 全局变量

　　　　int g_howMuchMoney;　　// 全局变量

　　类的数据成员加前缀m_（表示member），这样可以避免数据成员与成员函数的参数同名

　　　　例如：

　　　　void Object::SetValue(int width, int height)

　　　　{

　　　　m_width = width;

　　　　m_height = height;

　　　　}

　　为了防止某一软件库中的一些标识符和其它软件库中的冲突，可以为各种标识符加上能反映软件性质的前缀

　　　　例如：

　　　　三维图形标准OpenGL的所有库函数均以gl开头，所有常量（或宏定义）均以GL开头

　　用正确的反义词组命名具有互斥意义的变量或相反动作的函数等

　　　　例如：

　　　　int      minValue;

　　　　int      maxValue;

　　　　int      SetValue(…);

　　　　int      GetValue(…);

　　尽量避免名字中出现数字编号，除非逻辑上的确需要编号

　　　　例如：

　　　　Value1,Value2等

　　不要出现仅靠大小写区分的相似的标识符

　　　　例如：

　　　　int  x,  X;      　　　　// 变量x 与 X 容易混淆

　　　　void foo(int x);    　　// 函数foo 与FOO容易混淆

　　　　void FOO(float x);

　　不要出现标识符完全相同的局部变量和全局变量

(3) 命名中的一些简写规则；

　　几开头的3-4个字母

　　　　例如：exp=expert expe=experience lux=luxury prosperous=pros

　　首尾字母

　　　　例如：yr=year tx=telex

　　去掉元音

　　　　例如：pls=please rcv=receive rgd=registered dmst=demonstration

　　谐音法

　　　　例如：u=you 8=ate 4=for 2=to

　　符号法

　　　　例如：>=more than <=less than p+3%=price increase 3%

(4) Matlab支持函数间的相互调用；

M文件可以包含2个以上的函数，第一个函数就是主函数，通过M文件的名字就可以调用这个函数。除主函数外，其余的函数就是子函数。子函数只能被本文件中的主函数和子函数调用。主函数必须排在前面，子函数的顺序可以任意排列。

(5) 函数可以按少于函数M文件中所规定的输入和输出变量进行调用，但不能多于函数M文件中所规定的输入和输出变量数目；

变量nargin包含输入参数的个数；变量nargout包含输出参数的个数。

(6) 函数有它们自己的专用工作空间，它与Matlab的工作空间分开；

(7) 实际编程中，无论什么时候应尽量避免使用全局变量；

注意：全局变量global只能为1个值，不能为向量或者矩阵；而函数之间的参数可传递向量。

(8) 若在Matlab中输入一个符号，则按变量、内置函数和外部函数的顺序搜索；

(9) 从函数M文件内可以调用脚本文件；

在这种情况下，脚本文件查看函数工作空间，不查看Matlab工作空间。从函数M文件内调用的脚本文件不必调用函数编译到内存。函数每调用一次，它们就被打开和解释。因此，从函数M文件内调用脚本文件减慢了函数的执行。

(10) 函数可以递归调用，即M文件函数能调用它们本身；

必须确保会终止，否则Matlab会陷入死循环。

(11) 当函数M文件到达M文件终点，或者碰到返回命令return时，结束执行和返回。

(12) Matlab函数error()在命令窗口显示一个字符串，放弃函数执行，把控制权返回给键盘。

这个函数对提示函数使用不当很有用。