《matlab-代码-规范》由会员分享，可在线阅读，更多相关《matlab-代码-规范（9页珍藏版）》请在金锄头文库上搜索。
1、1.标识符命名原则标识符的名字应当直观，其长度应当符合最小长度，最大信息量”原则。1) 非矩阵变量：? 变量名应该以小写字母开头的大小写混合形式 譬如：shadowFadingTable ,servingSector, rxBufferForRe userID , userPriorityProfile , mcsOneRetrieval 等?循环变量应该以i、j、k等为前缀，如for i_File = 1 : nFilesfor j_Position = 1 : nPositions? 避免仅用最后的字母 s(表示单复数)区别两个变量，例如point和points,可以用类似 pointAr
2、ray的形式加以区别。?避免使用一个关键字或者特殊意义的字作为变量名?结构体的命名应该以一个大写字母开头，结构体的命名应该是暗示性的，并且不需要包括字段名(fieldname)应采用 Segment.length,避免用 Segment.SegmentLength2) 常数：? 命名常数(包括全局变量)应该采用大写字母，用下划线分割单词，如 MAX_ITERA TIONS , COLOR_RED?参数可以以某些通用类型名作为前缀，如 COLOR_RED , COLOR_GREEN3) )草稿变量，含矩阵，结构体，元胞：?应用范围比较大的变量应该具有有意义的变量名，作为“草稿变量”的的临时存储空
3、间或者索引可以用短名字。程序员在读到这样的变量的时候，可以假定这个变量 的值在没有几行之后的代码中就不会再用到。通常的“草稿变量”整数的时候用i,j, k, m, n (最好少用i, j,因为他们作为 MATLAB中的永久性常量表示虚数单 位的)。双精度数的时候常用x, y和z。m表示矩阵，没有 m表示标量? 命名上将cell, struct与MATLAB中最常见的numeric array,即数值矩阵区分开来.?n用于整数变量，如n_File.? m 用于一般的矩阵，如 matrix_channelHFResponse;? c 用于 cell array,如 cell_temp= cell(
4、1,4);? s 用于 struct array,如 stuct_user= struct(field, );? matrix , cell, stuct后面的channelHFResponse, user用来表示有特定含义的中间变 量，比如 matrix_channelHFResponse ,用来表示计算 channelHFResponse 时中间变量。4 )函数：?函数名应该采用小写字母，函数名应该是具有意义的，下划线分割单词如采用： compute_total_width ()避免 compwid ()? 前缀get/set应该作为访问对象或者属性的保留前缀，如 getobj (.)。?
5、 前缀compute应该用在计算某些量的函数的地方computespread ()。? 前缀is应该用在布尔函数的命名的地方，如 iscomplete ()。? Find, initialize 类似。2.编码及文档注释要求及实例2.1 代码版式2.1.1 M文件函数说明function 函数输出参数二 函数名（函数输入）%此处为函数名，如果不是函数文件就取消此行%创建人：%日期：%修改人：%日期：%函数变量及功能的简单描述%一函数主体2.1.2 编码设计本部分说明了 M文件编码的设计，包括以下几个方面：垂直间隔，水平间隔，缩进与对齐，注释。2.1.2.1 垂直间隔1、空行空行起着分割块或段落
6、的作用，块（段落）之间一般留一个或两个空行。空行使用规则：? 逻辑块之间要留空行；? 结构体定义之间要留空行；? 函数定义体之间要留空行；? 函数体内，完整的控制结构和单独的语句块之间要留空行；? 逻辑上密切相关的语句序列之间不要留空行；2、换行注意事项? 不在一行使用多个语句。唯一的例外是for语句。For语句的初始化，条件和循环都可以在一行中。例如for （bcnl_num = 0; bcnl_num count) bcnl_num = count;?与case总是独占一行。2.1.2.2 水平间隔? 逗号后面要有空格，但是不要在结构的成员与指针操作符前后有空格。例如：foo.index?
7、 在 = ， & ， + ， - ， , left_border) & (new_shape.x bottom_border) &(new_shape.y ”这类运算符前后都不要留空格。2.1.2.5 缩进与对齐? 缩进的水平是一个TAB 键，可将编辑器的 TAB 符定义为 4 个空格。? 嵌套块之间使用 4 个空格(一个TAB 键)的缩进方式。? 模块和子程序头以及子程序声明从第一列起。? 下列情况下缩进一个水平：子程序声明条件(看下面)循环的结构switch 语句case labels? 条件的else与if有相同的缩进。因此格式就是：fid = fopen (fileName )； if
8、 ( fid = -1 )statementselsestatementsend? switch 语句的一般格式：switch ( condition )caseABC处理语句；caseDEF处理语句； otherwise 处理语句； end? 注释与它们作注释的代码部分有相同的缩进(见Comments ) 。2.1.2.6 注释1） 程序内部不同功能模块要空一行，同时附注释说明模块的作用、功能。这样程序结构清晰易懂，便于同学间学习交流。例如：% 注释说明下模块一的功能模块一代码此处为空行%注释说明下模块二的功能模块二代码2） 多层循环嵌套要在每一个结束的end后加注释说明该层循环结束例：fo
9、r%循环1for %循环2for%循环3代码段end %循环3结束end %循环2结束end %循环1结束 3）用于理解一小段代码含义的注释，统一写在代码上方，如市话下的用户寸车 dklDb JLfiE&lTnfMSUSB二- SOUdE) 朋T瓯E * IB * 独E“风口=Tm. D厂目：VJctCodcbQQh5LtiS.7wDcadobcuJcII D.cnullnfulWJiFIda. iCKIdi)=必D Tinf?. 兀*求埼码才下的ffl户干苗呼市劝多txpKft?lAw22. I m；E_D /V: * HJISEInt erf f(u;trID - L) *】以一股亮掩工百
10、强颖幻其瑁它：黑丁煤用尸姓标工。区3工心兄?_,8二日中出、啊的第jxHiij xwem度底需养弗tejiCunLmAlj22_2 = u也匚uftpl9端口 022 JH3E_D_TwuJJJeeLuhLcbuuk .-Jiu(.CddebjukID. 1) Iftte1! f 七reriCe,Itrfa I二UHiJ 1 tbt? SCMtbc)户仃山db(t val (4EA.pCvlljL lerilAf I: h2_2 I ),)1.lu niL- i hi t , !i j j- fIi f II 1. _. . !. I ; J j lhi I III ih , :;11 Li
11、I _ _. Ih 11 -11 X i j H;r , - . Ai i 工二. I, J .的t号中/V幺卡必)teftDtlMAerZZ-l 三 WISS_U_tw4 * YM况_JlTp口4)用于理解一句代码的意思可以写在代码后方，但是注意不能超过180字符。太长可以考虑写在代码上方。,我鸟叁传包和重传庠户fcr AKQII：;AEQmif CtxButf&r CiserIP, 1). blockrnf o(AKQID). sRer ianb 1 oclc= 1TBuff er ；U3erIDj 1). NACKTine (/iSQID1 0t_ind-taEuff r虺tI凡 11.瓯KT(JUiOir) AARQIHffl-MKFEEDBKAt_:!i.d-z-1xBuff r(urIDHACKIIME Llfm+l)=t_irdex-tMBuffer tuserlD, 1). NACKTunt(ARQU) ; % 每个 Aft4逆程至专包的等精
