文档介绍:该【matlab-代码-规范 】是由【幸福人生】上传分享,文档一共【22】页,该文档可以免费在线阅读,需要了解更多关于【matlab-代码-规范 】的内容,可以使用淘豆网的站内搜索功能,选择自己适合的文档,以下文字是截取该文章内的部分文字,如需要获得完整电子版,请下载此文档到您的设备,方便您编辑和打印。matlab-代码-规范1标识符命名原则标识符的名字应当直观,其长度应当符合“最小长度,最大信息量”原则。非矩阵变量:变量名应该以小写字母开头的大小写混合形式譬如:shadowFadingTable,servingSector,rxBufferForReuserID,userPriorityProfile,mcsOneRetrieval等循环变量应该以i、j、k等为前缀,如fori_File=1:nFilesforj_Position=1:nPositions避免仅用最后的字母s(表示单复数)区别两个变量,。避免使用一个关键字或者特殊意义的字作为变量名结构体的命名应该以一个大写字母开头,结构体的命名应该是暗示性的,并且不需要包括字段名(fieldname),,如cell_temp=cell(1,4);s用于structarray,如stuct_user=struct('field',{});matrix,cell,stuct后面的channelHFResponse,user用来表示有特定含义的中间变量,比如matrix_channelHFResponse,用来表示计算channelHFResponse时中间变量。函数:函数名应该采用小写字母,函数名应该是具有意义的,下划线分割单词pute_total_width()pwid()前缀get/set应该作为访问对象或者属性的保留前缀,如getobj(.)。putespread()。前缀is应该用在布尔函数的命名的地方,plete()。Find,initialize类似。1编码及文档注释要求及实例代码版式M文件函数说明function[函数输出参数]=函数名(函数输入)%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%此处为函数名,如果不是函数文件就取消此行%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%创建人:%日期: %修改人: %日期: %函数变量及功能的简单描述%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%--函数主体2编码设计 本部分说明了M文件编码的设计,包括以下几个方面:垂直间隔,水平间隔,缩进与对齐,注释。垂直间隔1、空行空行起着分割块或段落的作用,块(段落)之间一般留一个或两个空行。空行使用规则:逻辑块之间要留空行;结构体定义之间要留空行;函数定义体之间要留空行;函数体内,完整的控制结构和单独的语句块之间要留空行;逻辑上密切相关的语句序列之间不要留空行;2、换行注意事项不在一行使用多个语句。唯一的例外是for语句。For语句的初始化,条件和循环都可以在一行中。例如3for(bcnl_num=0;bcnl_num<count;bcnl_num++)或者还有switch语句,如果动作很短并且相同的话(后面有详细描述)。If语句并不是例外:执行语句总是另起一行。例如: if(bcnl_num>count)?? ??bcnl_num=count;{}与case总是独占一行。水平间隔逗号后面要有空格,但是不要在结构的成员与指针操作符前后有空格。例如: =,&&,+,-,>,<与||前后加上空格,包括:如simpleAverage=(firstTerm+secondTerm)/two;1:nIterations另起一行时,后面一行和前面一行中要继续的地方对齐: weithedPopulation=(doctorWeight*nDoctors)+…(layerWeight*nLawyers)+…(chiefWeight*nChiefs);... function(param1,param2,…param3)4长行拆分一行代码不能超过180个字符。长行拆分时,在逻辑断点处分行。拆分时,运算符放在被拆分行的尾部,而不是新行的首部。拆分后的新行应与被拆分行采用能够表现出逻辑关系的对齐方式。示例:if(((>left_border)&&(<right_border))&&((>bottom_border)&&(<top_border))){ draw(new_shape);}代码行及行内空格代码行中不运行出现中文。关键字后要留空格。像const、inline、case等关键字后要留空格,以辨析关键字;像if、for、do、while、switch等关键字后要留空格再跟左括号“(”,以突出关键字。“(”若不在一行的开始,应与前面的字符空格。例如,if、while、do-while、switch、for语句等控制结构块的“(”应与这些关键字语句之间空格。6“,”之后要留空格;若“;”不是一行的结束符,后面也要留空格。“?”、“:”前后都要留空格。“(”、“[”向后紧跟,“]”、“,”、“;”、“)”向前紧跟,紧跟处不留空格。一元运算符与所作用的操作数之间不要加空格,如“!”、“~”、“++”、“&”、“*”等。“.”、“->”这类运算符前后都不要留空格。缩进与对齐缩进的水平是一个TAB键,可将编辑器的TAB符定义为4个空格。嵌套块之间使用4个空格(一个TAB键)的缩进方式。模块和子程序头以及子程序声明从第一列起。下列情况下缩进一个水平:子程序声明条件(看下面)循环的结构switch语句6caselabels条件的else与if有相同的缩进。因此格式就是:fid=fopen(fileName);if(fid~=-1)statementselsestatementsendswitch语句的一般格式: switch(condition)caseABC处理语句;caseDEF处理语句;otherwise处理语句;end 注释与它们作注释的代码部分有相同的缩进(见Comments)。注释程序内部不同功能模块要空一行,同时附注释说明模块的作用、功能。这样程序结构清晰易懂,便于同学间学****交流。例如:%%注释说明下模块一的功能??????…模块一…代码…?????此处为空行?????%%8