java编写规范.doc

HYPERLINK"http://gcgmh.javaeye.com/blog/313213"高质量JAVA代码编写规范
1.Java命名约定
除了以下几个特例之外，命名时应始终采用完整的英文描述符。此外，一般应采用小写字母，但类名、接口名以及任何非初始单词的第一个字母要大写。
1.1一般概念
*尽量使用完整的英文描述符
*采用适用于相关领域的术语
*采用大小写混合使名字可读
*尽量少用缩写，但如果用了，要明智地使用，且在整个工程中统一
*避免使用长的名字（小于15个字母是个好主意）
*避免使用类似的名字，或者仅仅是大小写不同的名字
*避免使用下划线（除静态常量等）
1.2示范
*包（Package）采用完整的英文描述符，应该都是由小写字母组成。对于全局包，将你的Internet域名反转并接上包名。如：
java.awtcn.itcast.cd
*类（Class）采用完整的英文描述符，所有单词的第一个字母大写。如：
Customer
SavingsAccount
*接口（Interface）采用完整的英文描述符说明接口封装，所有单词的第一个字母大写。习惯上，名字后面加上后缀able，ible或者er，但这不是必需的。如：
Contactable
Prompter
*组件/部件（Component）使用完整的英文描述来说明组件的用途，末端应接上组件类型。如：okButton
customerList
fileMenu
*异常（Exception）通常采用字母e表示异常。e
*类变量字段采用完整的英文描述，第一个字母小写，任何中间单词的首字大写，如：firstNamelastName
*实参/参数同字段/属性的命名规则
publicvoidsetFirstName(StringfirstName){
this.firstName=firstName;
}
局部变量同字段/属性的命名规则
**获取成员方法被访问字段名的前面加上前缀get。getFirstName(),getLastName()
**布尔型的获取成员方法所有的布尔型获取方法必须用单词is做前缀。isPersistent(),isString()
**设置成员方法被访问字段名的前面加上前缀set。setFirstName(),setLastName(),setWarpSpeed()
**普通成员方法采用完整的英文描述说明成员方法功能，第一个单词尽可能采用一个生动的动词，第一个字母小写。openFile(),addAccount()
静态常量字段（staticfinal）全部采用大写字母，单词之间用下划线分隔。MIN_BALANCE,DEFAULT_DATE*循环计数器通常采用字母i，j，k或者counter都可以接受。i,j,k,counter
*数组数组应该总是用下面的方式来命名：byte[]buffer;
2.Java注释约定
一个很好的可遵循的有关注释的经验法则是：问问你自己，你如果从未见过这段代码，要在合理的时间内有效地明白这段代码，你需要哪些信息。
2.1.一般概念
*注释应该增加代码的清晰度
*保持注释的简洁
*在写代码之前写注释
*注释出为什么做了一些事，而不仅仅是做了什么
2.2.示范
*文档注释在紧靠接口、类、成员方法和字段声明的前面注释它们。
/**
*
客户：客户是我们将服务和产品卖给的人或机构。
*/
C语言风格
采用C语言风格的注释去掉不再使用但你仍想保留的代码。仍想保留是因为用户万一会改变想法，或者在调试过程中想让它暂时失效。如：
/*这部分代码因为已被它之前的代码取代，由B.Gustafsson,于1999年6月
*4日注释掉。如果两年之后还未使用，将其删除。...
*（源代码）
*/
单行
在成员方法内采用单行注释，来说明业务逻辑、代码段和暂时变量的声明。注释符"//"后必须紧跟一个空格，然后才是注释信息。如：
//遵照Sarek的规定，给所有
//超过$1000的发货单
//打5%的折扣。让利活
//动于1995年2月开始.
2.3.注释哪些部分
类类的目的、即类所完成的功能，注释出采用的变量。
接口设置接口的目的、它应如何被使用以及如何不被使用。
成员方法注释对于设置与获取成员方法，在成员变量已有说明的情况下，可以不加注释；普通成员方法要求说明完成什么功能，参数含义是什么返回什么；
普通成员方法内部注释控制结构，代码做了些什么以及为什么这样做，处理顺序等。
实参/参数参数含义、及其它任何约束或前提条件
字段/属性字段描述
局部变量无特别意义的情况下不加注释
3.Java文件样式约定
所有的Java(*.java)文件都必须遵守如下的样式规则：
版权信息
版权信息必须在java文件的开头，比如