MATLAB 编程格式规范.pdfVIP

MATLAB 编程格式规范 一. 编程灵魂 1. 正确：能准确实现原仿真目的； 2. 高效：循环向量化，少用或不用循环，尽量调用MATLAB 自带函数； 3. 清晰：养成良好的编程习惯，程序具有良好的可读性； 4. 通用：程序具高度的可移植性，同时易于扩展，避免同学之间重复工作。 二. 编程规则 1. 定义变量，以英文单词小写缩写开头表示类别名，再接具体变量的英文名称英文单词， 具体变量首字母大写。 教研室常用类别缩写：最大值 max ，最小值 min 例如：定义变量存贮临时数组TempArray 的最大值 maxTempArray 依照工程大小确定变量名长短，小范围应用的变量应该用短的变量名。定义务必清晰， 避免混淆。 2. 循环变量使用常用变量i,j,k ；程序中使用复数时，采用i,j 以外的循环变量以避免和虚数 单位冲突，同时要在注释部分说明变量意义。 3. 程序应高内聚、低耦合、模块函数化，便于移植、重复使用。 4. 使用if 语句判断变量是否等于某一常数时，将常变量数写在等号之前，常数写在等号之 后。 例如判断变量a 是否等于100 写作if a ==100 。 5. 用常数代替数字，少用或不用数字。 例如上一条：写作if a = =100 就不标准。应先定义meanConst=100 ；为期望常量。同时 在注释中说明，然后在程序部分写作：if a = =const；如果要修改期望常量的话，只要在 程序定义部分修改就可以，不必再逐行修改，此外还易于在该程序的基础上增加其他功 能。 三. 注释规则 1. 注释要用汉语，且用一个“%”连接文字作为注释开始标志。程序的起始要注明作者、时间、 程序功能、复杂的算法需要加上流程说明。对于比较复杂的程序，由几个人协作完成， 要在每一个模块的起始分别注明作者、时间、程序功能。注释采用matlab 的注释符号。 同时第一行增加关键字，便于将来程序文件较多时，使用help 和lookfor 查找。例如： %关键字%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %此处为函数名，如果不是函数文件就取消此行 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %创建人： % 日期： %修改人： % 日期： %函数变量及功能的简单描述 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 2. 对于所有有物理含义的变量、常量、数据结构声明，在声明时都必须加以注释，说明其 物理含义，单位。 3. 源程序有效注释量必须在20% 以上，边写代码边注释，修改代码同时修改相应的注释， 以保证注释与代码的一致性，不再有用的注释要删除。注释语言必须准确、易懂、简洁， 尽量不要用缩写。如果接手前人的程序，在维护过程中需要对变量以及源程序作部分修 改及 补充，在修改变量及程序注释的同时需要在修改的位置标明修改人的名字及修改 日期。 对原程序修改要及时修改注释。否则有注释比没有注释还要糟糕。 4. 程序内部不同功能模块要空一行，同时附注释说明模块的作用、功能。这样程序结构清 晰易懂，便于同学间学习交流。 例如： …模块一…代码… 此处为空行 %注释说明下一模块的功能%%%%%%% …模块二…代码… 5. 一行代码不宜过长，应限制在80 列之内。一旦有过长代码须用MATLAB 转接符号“...” 连接两行代码，以便于同学之间打印程序交流。因为大多是打印机的行长度为80。 例 ： 第一行代码 nVariable=1+1+1++1+1+1+1+1+1+11+1+1+1+1+1+1+1+1+1+ 1+1+1... 第二行代码 +1+1+1; 6. 多层循环嵌套要在每一个结束的end 后加注释说明该层循环结束。这样程序结构清晰易 懂，便于同学间学习交流。多层循环嵌套不推荐使用，但是万一要使用务必采用以下格 式。 例:for %循环1 for %循环2 for %循环3