总结前期做的几个项目,个人认为代码的规范对团队的协作有着密切的关系。现将一些常用的约束总结如下,以便今后参阅:
一、命名
1、所有的类、属性、方法都遵守以字母和数字为主,尽量不要参与特殊符号如下划线。其次,除类名开头字母大写外,其他名字都要小写,然后第二个后的单词首字母大写,长度在30个字符以内。
2、局部变量和全局变量的名字不能相同。
3、变量命名时也不能与其它方法重名。
4、变量命名尽量清晰可读,并带有一定含义。
5、接口中的方法按照返回类型、方法名、参数、异常、分号的方式编写,由于接口中的方法默认都以public static final修饰,所以返回类型前面可以不做声明。
二、代码排版
1、方法体内按照 静态变量(以static修饰)--->注入或引入的关联变量(以@Autowired修饰或引入的service或DAO)--->自己命名的变量 ---> 无参构造 --->有参构造 --->方法内容 ----> getter和setter的方法
2、每个方法的长度控制在150行内。
3、方法中所有常量字符统一整理在某个类内,如Constants,其所有的属性都以public static final修饰,并且变量名字全部大写,单词之间用下划线隔开。
4、代码编写完成后排除掉warning的黄色警告,再格式化代码,以增强代码的美观。其中Ctrl+Shift+f 格式化代码,Ctrl+Shift+o快速导包,同时去处没有用到import。
5、每个方法中的return不得超过3个。
6、不要为Boolean,Integer或String创建新的实例:
避免创建新的Boolean,Integer,String等实例。使用Boolean.valueOf(true)代替new Boolean(true)。两种写法效果差不多但却可以改善性能。
7、在代码块周围使用大括号:
永远不要忘记在块类型语句(如:if,for,while)周围使用大括号。这可以减少代码歧义并且避免在你修改代码块的时候产生新的bug。
8、养成写注释的好习惯。
[/size][/size][/size]
已有 0 人发表留言,猛击->> 这里<<-参与讨论
ITeye推荐