matlab 代码 规范.docVIP

标识符命名原则 标识符的名字应当直观，其长度应当符合“最小长度，最大信息量”原则。 非矩阵变量： 变量名应该以小写字母开头的大小写混合形式 譬如：shadowFadingTable，servingSector， rxBufferForRe userID，userPriorityProfile，mcsOneRetrieval等 循环变量应该以i、j、k等为前缀，如 for i_File = 1：nFiles for j_Position = 1：nPositions 避免仅用最后的字母s(表示单复数)区别两个变量, 例如point和points. 可以用类似pointArray的形式加以区别。 避免使用一个关键字或者特殊意义的字作为变量名 常数： 命名常数（包括全局变量）应该采用大写字母，用下划线分割单词，如MAX_ITERATIONS，COLOR_RED 参数可以以某些通用类型名作为前缀，如COLOR_RED，COLOR_GREEN矩阵，结构体，元胞：应用范围比较大的变量应该具有有意义的变量名。m表示矩阵，没有m表示标量 命名上将cell, struct与MATLAB中最常见的numeric array, 即数值矩阵区分开来. n用于整数变量, 如n_File. m用于一般的矩阵，如matrix_channelHFResponse; c用于cell array, 如cell_temp= cell(1, 4); s用于struct array, 如stuct_user= struct(field, {}); matrix，cell，stuct后面的channelHFResponse， user用来表示有特定含义的中间变量，比如matrix_channelHFResponse，用来表示计算channelHFResponse时中间变量。 函数： 函数名应该采用小写字母，函数名应该是具有意义的，下划线分割单词 如采用： compute_total_width（）避免compwid（） 前缀get/set 应该作为访问对象或者属性的保留前缀，如getobj（.）。 前缀compute应该用在计算某些量的函数的地方computespread（）。 前缀 is应该用在布尔函数的命名的地方，如 iscomplete（）。Find，initialize类似。 编码及文档注释要求及实例 代码版式 M文件函数说明 function [ 函数输出参数] = 函数名( 函数输入 ) %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %此处为函数名，如果不是函数文件就取消此行 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %创建人： %日 期： %修改人： %日 期： %函数变量及功能的简单描述 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% --函数主体 编码设计 本部分说明了M文件编码的设计，包括以下几个方面： 垂直间隔水平间隔缩进与对齐注释 垂直间隔 1、空行 空行起着分割块或段落的作用，块（段落）之间一般留一个或两个空行。 空行使用规则： 逻辑块之间要留空行； 结构定义之间要留空行； 函数定义体之间要留空行； 函数体内，完整的控制结构和单独的语句块之间要留空行； 逻辑上密切相关的语句序列之间不要留空行； 2、换行注意事项 不在一行使用多个语句。唯一的例外是for语句。For语句的初始化，条件和循环都可以在一行中。例如 for (bcnl_num = 0; bcnl_num count; bcnl_num++) 或者还有switch语句，如果动作很短并且相同的话（后面有详细描述）。 If语句并不是例外：执行语句总是另起一行。例如： if (bcnl_num count) ?? ??bcnl_num = count; ｛｝与case总是独占一行。 水平间隔 逗号后面要有空格，但是不要在结构的成员与指针操作符前后有空格。例如： foo.index 在 =，，+，-，, 与 | 前后加上空格：simpleAverage = (firstTerm + secondTerm) / two; 1 : nIterations 另起一行时，后面一行和前面一行中要继续的地方对齐： weithedPopulation = (doctorWeight * nDoctors) + … (layerWeight * nLawyers) + …