Java编码规范v0.1版.doc

Java 编码规范 版 一般概念 n尽量使用完整的英文描述符 n采用适用于相关领域的术语 n采用大小写混合使名字可读 n尽量少用缩写,但如果用了,要明智地使用,且在整个工程中统一 n避免使用长的名字(小于 15个字母是个好主意) n避免使用类似的名字,或者仅仅是大小写不同的名字 n避免使用下划线(除静态常量等) 示范包( Package ) 采用完整的英文描述符,应该都是由小写字母组成。对于全局包,将你的 域名反转并接上包名。 java.. 类( Class ) 采用完整的英文描述符,所有单词的第一个字母大写。 Customer, ount 接口( Interface ) 采用完整的英文描述符说明接口封装,所有单词的第一个字母大写。习惯上,名字后面加上后缀 able ,ible 或者 er,但这不是必需的。 Contactable,Prompter 组件/部件( Component ) 使用完整的英文描述来说明组件的用途,末端应接上组件类型。 okButton, customerList,fileMenu 异常( Exception ) 通常采用字母 e表示异常。 e 类变量字段采用完整的英文描述,第一个字母小写,任何中间单词的首字母大写。 firstName, lastName 实参/参数同字段/属性的命名规则 public void setFirstName(String firstName) { =firstName; }局部变量同字段/属性的命名规则<类变量> 获取成员函数被访问字段名的前面加上前缀 get 。getFirstName(), getLastName() 布尔型的获取成员函数所有的布尔型获取函数必须用单词 is做前缀。 isPersistent(), isString() 设置成员函数被访问字段名的前面加上前缀 set 。setFirstName(), setLastName(),setWarpSpeed() 普通成员函数采用完整的英文描述说明成员函数功能,第一个单词尽可能采用一个生动的动词,第一个字母小写。 openFile(), ount() 静态常量字段( static final ) 全部采用大写字母,单词之间用下划线分隔。 MIN_BALANCE, DEFAULT_DATE 循环计数器通常采用字母 i,j,k或者 counter 都可以接受。 i,j,k, counter 数组数组应该总是用下面的方式来命名:object Type[] 。byte[] buffer; 2. Java 注释约定一个很好的可遵循的有关注释的经验法则是:问问你自己,你如果从未见过这段代码要在合理的时间内有效地明白这段代码,你需要哪些信息。 . 一般概念 n注释应该增加代码的清晰度 n保持注释的简洁 n在写代码之前写注释 n注释出为什么做了一些事,而不仅仅是做了什么 . 示范文档注释在紧靠接口、类、成员函数和字段声明的前面注释它们。/** 客户:客户是我们将服务和产品卖给的人或机构。*/C语言风格采用 C语言风格的注释去掉不再使用但你仍想保留的代码。仍想保留是因为用户万一会改变想法, 或者在调试过程中想让它暂时失效。/*这部分代码因为已被它