JAVA开发规范.doc

文思海辉技术有限公司
JAVA开发规范文档
2016年06月
目录
1 绪论 1
目的 1
范围 1
版权声明 1
概述 1
2 代码组织与风格 2
基本原则 2
缩进 2
长度 2
行宽 3
间隔 3
对齐 3
括号 4
3 注释 4
基本原则 4
JavaDoc 4
文件与包注释 4
类与方法注释 5
其他注释 6
注释参考表 7
4 命名 8
基本原则 8
文件、包 9
类、接口 9
字段 9
常量 9
变量和参数 9
组件/部件 10
集合 10
神秘的数 10
其他 10
方法 11
异常 11
命名约定表 11
5 声明 13
基本原则 13
包 13
类、接口 13
方法 13
字段 14
示例 15
6 类与接口 17
基本原则 17
抽象类与接口 17
继承与组合 17
构造方法和静态工厂方法 17
toString() 18
Singleton Class 19
7 方法 19
基本原则 19
参数和返回值 20
输入参数合法性判断原则 21
8 表达式与语句 22
基本原则 22
控制语句 23
循环语句 27
9 错误与异常 28
基本原则 28
已检查异常与运行时异常 28
异常的传递 29
异常处理规范 30
异常处理范例 31
异常捕获 31
异常捕获位置 31
异常处理方法 32
10 性能与安全 32
基本原则 32
String与StringBugffer 32
确定 StringBuffer的容量 33
集合 33
对象 34
同步 34
final 34
垃圾收集和资源释放 35
使用‘ ()‘代替通过来循环复制数组 35
11 附录 37
常用缩写简表 37
绪论
目的
本规范的目的是使本组织能以标准的、规范的方式设计和编码。通过建立编码规范,以使每个开发人员养成良好的编码风格和习惯;并以此形成开发小组编码约定,提高程序的可靠性、可读性、可修改性、可维护性和一致性等,增进团队间的交流,并保证软件产品的质量。
版权声明
未经原作者授权,任何个人、组织或单位不得将本文档用于书面发表、转载、摘录等,亦不得用于其他商业行为。
概述
一个软件的生命周期中,80%的时间在于维护。几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护,编码规范可以改善软件的可读性、可维护性,可以让开发或维护人员尽快而彻底地理解新的代码。如果将源码作为产品发布,就需要确认它是否被很好的打包并且清晰无误。
代码组织与风格
基本原则
代码的组织和风格的基本原则是:便于自己的开发,提高代码可读性,易于后期测试与维护。
本章所涉及到的内容一般都可在Java集成编辑环境eclipse中进行相应设置,可由Ant等调用Checkstyle工具来进行自动代码检查。
缩进
子功能块应当在其父功能块后缩进。当功能块过多而导致缩进过深时应当将子功能块提取出来做为子方法。
代码中以TAB(4个字符)缩进,在编辑器中请将TAB设置为以空格替代,否则在不同编辑器设置下会导致TAB长度不等而影响整个程序代码的格式。例如:
缩进示例
public void methodName(){
if(some condition){
for(…){
//some sentences
}//end for
}//end if
}
长度
为便于阅读和理解,单个方法的有效代码长度必须控制在100行以内(包括注释行、减少方法内简单代码的注释),当一个功能模块过大时往往造成阅读困难,因此当使用子方法等将相应功能抽取出来,这也有利于提高代码的重用度。
单个类也不宜过大,当出现此类情况时当将相应功能的代码重构到其他类中,通过组合等方式来调用,建议单个类的长度包括注释行不能超过1500行。
尽量避免使用大类和长方法。
行宽
页宽应该设置