matlab-代码-规范(word文档良心出品).doc

《matlab-代码-规范(word文档良心出品).doc》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、1.标识符命名原则标识符的名字应当直观，其长度应当符合“最小长度，最大信息量”原则。1)非矩阵变量：Ø变量名应该以小写字母开头的大小写混合形式譬如：shadowFadingTable，servingSector，rxBufferForReuserID，userPriorityProfile，mcsOneRetrieval等Ø循环变量应该以i、j、k等为前缀，如fori_File=1：nFilesforj_Position=1：nPositionsØ避免仅用最后的字母s(表示单复数)区别两个变量,例如point

2、和points.可以用类似pointArray的形式加以区别。Ø避免使用一个关键字或者特殊意义的字作为变量名Ø结构体的命名应该以一个大写字母开头，结构体的命名应该是暗示性的，并且不需要包括字段名（fieldname）应采用Segment.length，避免用Segment.SegmentLength2)常数：Ø命名常数（包括全局变量）应该采用大写字母，用下划线分割单词，如MAX_ITERATIONS，COLOR_REDØ参数可以以某些通用类型名作为前缀，如COLOR_RED，COLOR_GREEN3）草稿变量

3、，含矩阵，结构体，元胞：Ø应用范围比较大的变量应该具有有意义的变量名，作为“草稿变量”的的临时存储空间或者索引可以用短名字。程序员在读到这样的变量的时候，可以假定这个变量的值在没有几行之后的代码中就不会再用到。通常的“草稿变量”整数的时候用i，j，k，m，n（最好少用i，j，因为他们作为MATLAB中的永久性常量表示虚数单位的）。双精度数的时候常用x，y和z。m表示矩阵，没有m表示标量Ø命名上将cell,struct与MATLAB中最常见的numericarray,即数值矩阵区分开来.Øn用于整数变量,如n_

4、File.Øm用于一般的矩阵，如matrix_channelHFResponse;Øc用于cellarray,如cell_temp=cell(1,4);Øs用于structarray,如stuct_user=struct('field',{});Ømatrix，cell，stuct后面的channelHFResponse，user用来表示有特定含义的中间变量，比如matrix_channelHFResponse，用来表示计算channelHFResponse时中间变量。4）函数：Ø函数名应该采用小写字母，函数

5、名应该是具有意义的，下划线分割单词如采用：compute_total_width（）避免compwid（）Ø前缀get/set应该作为访问对象或者属性的保留前缀，如getobj（.）。Ø前缀compute应该用在计算某些量的函数的地方computespread（）。Ø前缀is应该用在布尔函数的命名的地方，如iscomplete（）。ØFind，initialize类似。1.编码及文档注释要求及实例1.1代码版式1.1.1M文件函数说明function[函数输出参数]=函数名(函数输入)%%%%%%%%%%%%

6、%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%此处为函数名，如果不是函数文件就取消此行%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%创建人：%日期：%修改人：%日期：%函数变量及功能的简单描述%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%--函数主体1.1.2编码设计本部分说明了M文件编码的设计，包括以下几个方面：垂直间隔，水平间隔，缩进与对齐，注释。1.1.2.1垂直间隔1、空行空行起

7、着分割块或段落的作用，块（段落）之间一般留一个或两个空行。空行使用规则：Ø逻辑块之间要留空行；Ø结构体定义之间要留空行；Ø函数定义体之间要留空行；Ø函数体内，完整的控制结构和单独的语句块之间要留空行；Ø逻辑上密切相关的语句序列之间不要留空行；2、换行注意事项Ø不在一行使用多个语句。唯一的例外是for语句。For语句的初始化，条件和循环都可以在一行中。例如for(bcnl_num=0;bcnl_num

8、句并不是例外：执行语句总是另起一行。例如：if(bcnl_num>count)    bcnl_num=count;Ø｛｝与case总是独占一行。1.1.1.1水平间隔Ø逗号后面要有空格，但是不要在结构的成员与指针操作符前后有空格。例如：foo.indexØ在=，&&，+，-，>,<与

9、

10、前后加上空格，包括：如simpleAverage=(firstTerm+secondTerm)/two;1:nI