当前位置:首页 > 行业资料 > 其它行业文档 > matlab命名习惯
《Matlab编程风格》读书笔记——命名习惯1.1概要*命名多维变量或常量应该具有单位后缀;*命名中尽量避免缩写;*考虑使得名字可以拼读;*所有命名都应该以英语的形式给出。1.2变量*变量的名称应该反应意义或用途。*应该是以小写字母开头的大小写混合形式。*大范围变量命名应该有意义,小范围变量应该尽可能简短。如循环变量多用ijkmn等,双精度数多用xyz*集合变量一般多用Array标记,尽量不要使用单词的复数形式。如pointArray*只代表单个个体的变量可以用No或i标记如tableNo,iTable*循环变量以ijk等开头*单个变量用n开头,向量用a开头,矩阵用m开头。*尽量避免否定式布尔变量命名。如isNotFound不好,用~isFound。*缩写形式,即使是大写缩写,也要大小写字母混合。如isUSASpecific不好,用isUsaSpecific1.3常数*应该使用大写字面,用下划线分割单词。如MAX_ITERATIONS*可以使用某些通用类型名为前缀,指明它们属于哪一类。如COLOR_RED,COLOR_BLUE1.4结构体*应该以一个大写字母开头。如Point*其字段命名不应该包含结构体名如Segment.SegementLength是不好的,直接用Segment.length1.5函数*函数名应该表明函数用途。*函数名应该与它的m文件同名。*函数名应该采用小写字母,可以用下划线隔开。如getname,get_name*尽量不要使用短命名,使用完整单词增强可读性,但广泛使用的缩写或首字母缩写例外。如compwid不好,使用computewidth。max,gcd都可以。*单输出变量函数可根据输出参数命名。如mean*没有输出变量或返回值为句柄的函数根据其功能命名。如plot*前缀set/get应该作为访问对象或者属性的保留前缀。如getobj,setappdata。*前缀compute用在某些量的计算上,暗指比较好耗时的操作。如computespread*前缀find用在具有查询功能的函数上,可以增强可读性,是get的一个好的替代品。如findoldestrecord,*前缀initialize可以用在对象或概念建立的地方。如initializeproblemstate*前缀is应该用在布尔函数的命名的地方。如iscomplete*补足型前缀应该用在补足型操作的地方。如get/set,add/remove,create/destroy,start/stop,insert/delete,increment/decrement,old/new,begin/end,first/last,up/down,min/max,next/previous,open/close,show/hide,suspend/resume。*避免无意识的覆盖。保证函数名的唯一性。可以用which–all或exist检查函数是否存在。
本文标题:matlab命名习惯
链接地址:https://www.777doc.com/doc-2887217 .html