java编码书写规范

《java编码书写规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、万洲科技有限公司Java编码书写规范（v1.0）万洲科技有限公司2010年4月Java编码书写规范目录1.命名约定11.1.一般概念11.2.示范12.注释约定42.1.一般概念42.2.示范42.3.注释范围53.文件样式约定53.1.Java(*.java)53.1.1.版权信息63.1.2.Package/Imports63.1.3.Class63.1.4.ClassFields73.1.5.构造函数83.1.6.克隆方法83.1.7.类方法（类的普通成员函数）93.1.8.toString方法93.1.9.ma

2、in方法93.2.JavaServerPage(*.jsp)93.2.1.版本信息103.2.2.tag103.2.3.值输出113.2.4.嵌入代码段114.其它代码书写风格约定114.1.文档自动生成114.2.缩进124.3.页宽124.4.变量声明144.5.变量初始化144.6.局部变量声明144.7.空行144.8.大括号{}154.9.小括号（）15-II-Java编码书写规范4.10.运算符154.11.参数间隔154.12.JSP文件命名164.13.Servlet类命名（待定）165.编码指南165

3、.1.对实例以及类变量的访问控制165.2.引用类变量和类方法165.3.常量175.4.变量赋值175.5.其它惯例185.5.1.圆括号185.5.2.返回值185.5.3.条件运算符"?"前的表达式195.5.4.特殊注释195.5.5.异常使用原则19-II-Java编码书写规范1.命名约定除了以下几个特例之外，命名时必须始终采用完整的英文描述符。此外，一般应采用小写字母，但类名、接口名以及任何非初始单词的第一个字母要大写。1.1.一般概念F尽量使用完整的英文描述符F采用适用于相关领域的术语F采用大小写混合使名

4、字可读F尽量少用缩写，但如果用了，要明智地使用，且在整个工程中统一F避免使用长的名字（尽量小于25个字母）F避免使用类似的名字，或者仅仅是大小写不同的名字F避免使用下划线（除静态常量等）1.2.示范包（Package）采用完整的英文描述符，应该都是由小写字母组成，格式为com.wzsoft.*。如：com.wzsoft.webcom.wzsoft.actioncom.wzsoft.modelcom.wzsoft.managercom.wzsoft.manager.impl类（Class）采用完整的英文描述符，所有单词的

5、第一个字母大写，在上下文语境允许的情况下，可以使用缩略词，但必须保证整个开发小组的一致性，比如：number可缩写为num。如：Customer-19-Java编码书写规范SavingsAccount接口（Interface）采用完整的英文描述符说明接口封装，所有单词的第一个字母大写。在接口名称的最前面使用大写的“I”表明这是一个接口。习惯上，名字后面加上后缀able，ible或者er，但这不是必需的。如：IContactableIPrompter组件/部件（Component）使用完整的英文描述来说明组件的用途，前端

6、加上组件类型。如：btnOKlstCustomermenuFile异常（Exception）采用异常类型的各单词首字母表示异常。如：ExcpetioneIOExceptionioe字段/属性字段采用完整的英文描述，第一个字母小写，任何中间单词的首字母大写。firstNamelastName实参/参数同字段/属性的命名规则publicvoidsetFirstName(StringfirstName){this.firstName=firstName;}局部变量同字段/属性的命名规则-19-Java编码书写规范获取成员函数

7、被访问字段名的前面加上前缀get。getFirstName()getLastName()布尔型的获取成员函数所有的布尔型获取函数必须用单词is做前缀。isPersistent()isString()设置成员函数被访问字段名的前面加上前缀set。setFirstName()setLastName()setWarpSpeed()普通成员函数采用完整的英文描述说明成员函数功能，第一个单词尽可能采用一个动词，第一个字母小写。openFile()addAccount()静态常量字段（staticfinal）全部采用大写字母，单词

8、之间用下划线分隔。MIN_BALANCE,DEFAULT_DATE循环计数器通常采用字母i，j，k，m，n或者counter都可以接受。i,j,km,n,counter数组应该总是用下面的方式来命名：objectType[]variant，不得使用objectTypevariant[]方式。int[]arrInt;String[]