最近经常看一些朋友写的源代码,总是感觉编码规范问题还没有成为大家的关注点,导致
代码的通用可读性相对比较差;
所以在此唠叨几句编码规范(以
struts2+spring2+hibernate3 架构的项目为例),大
家各取所需,欢迎拍砖!
一、规范存在的意义
应用编码规范对于软件本身和软件开发人员而言尤为重要,有以下几个原因:
1
、好的编码规范可以尽可能的减少一个软件的维护成本
, 并且几乎没有任何
一个软件,在其整个生命周期中,均由最初的开发人员来维护;
2、好的编码规范可以改善软件的可读性,可以让开发人员尽快而彻底地理解
新的代码;
3、好的编码规范可以最大限度的提高团队开发的合作效率;
4、长期的规范性编码还可以让开发人员养成好的编码习惯,甚至锻炼出更加
严谨的思维;
二、命名规范
1、一般概念
1、尽量使用完整的英文描述符
2、采用适用于相关领域的术语
3、采用大小写混合使名字可读
4、尽量少用缩写,但如果用了,必须符合整个工程中的统一定义
5
、避免使用长的名字(小于
15 个字母为正常选择)
6、避免使用类似的名字,或者仅仅是大小写不同的名字
7、避免使用下划线(除静态常量等)
2、标识符类型说明