software camp——编程规范:命名
原则:团队为包、类、方法、变量取一个好名字,使代码易于理解
好的命名有如下特征:
a.能清晰的表达意图
b.避免造成误导
c.避免不必要的编解码
比如在Java中不建议采用匈牙利命名法
d.能区分出意思
建议不要在变量/类名后加data,info,object等一般意义的词
e.不用或少用缩写
小于15个字母的一般不用缩写,超过15个字母的可采用去掉元音的方法或者行业内约定俗成的缩写,且缩写保持驼峰格式。
规则1:禁止使用魔鬼数字
直接使用数字,造成代码难以理解也难以维护。应采用有意义的静态变量或枚举来代替。有些特殊情况下,如循环比较时采用数字0,-1,1,这些情况可采用数字。
规则2:常量命名,由全大写单词组成,单词间用下划线分隔,且使用static final修饰。
首先static保证一个类只有一个,保证常量的唯一性,final保证常量不可变更。
规则3:变量、属性命名,使用名词,并采用首字母小写的驼峰命名法。
驼峰命名是指第一个单词字母使用小写,剩余单词首字母大写其余字母小写的大小写混合法。含有集合意义的属性,名称尽量包含复数。
规则4:方法的命名,用动词和动宾结构,采用首字母小写的驼峰命名法。
格式如下:
get+非布尔属性名()
is+布尔属性名()
set+属性名()
has+名词/形容词()
动词() 主要用在动作作用在对象自身上
动词+宾语()
规则5:类和接口的命名,采用首字母大写的驼峰命名法
类的命名,不应用动词,而应使用名词,如Customer,WikiPage,Account,避免采用类似Manager,Processor,Data,Info这样模糊的词。(不推荐使用汉字)
规则6:包的命名,由一个或若干个单词组成,所有的字母均为小写
包名采用域后缀倒置的加上自定义的包名,采用小写字母,再加上产品名称和模块名称。应该规划好包名的范围,防止产生冲突。
建议1:数组声明的时候使用int[] index,而不要使用int index[]