编码书写规范-Java.doc

《编码书写规范-Java.doc》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、目录1.命名约定11.1.一般概念11.2.示范12.注释约定32.1.一般概念42.2.示范42.3.注释哪些部分53.文件样式约定53.1.Java(*.java)53.1.1.版权信息53.1.2.Package/Imports53.1.3.Class63.1.4.ClassFields63.1.5.存取方法（类的设置与获取成员函数）73.1.6.构造函数73.1.7.克隆方法73.1.8.类方法（类的普通成员函数）83.1.9.toString方法83.1.10.main方法83.2.Java

2、ServerPage(*.jsp)93.2.1.版本信息93.2.2.tag93.2.3.定义103.2.4.值输出103.2.5.嵌入代码段104.其它代码书写风格约定114.1.文档化114.2.缩进114.3.页宽114.4.{}对114.5.括号114.6.运算符124.7.参数之间124.8.JSP文件命名124.9.Servlet类命名125.附件125.1.使用方法131.命名约定除了以下几个特例之外，命名时应始终采用完整的英文描述符。此外，一般应采用小写字母，但类名、接口名以及任何非初

3、始单词的第一个字母要大写。1.1.一般概念F尽量使用完整的英文描述符F采用适用于相关领域的术语F采用大小写混合使名字可读F尽量少用缩写，但如果用了，要明智地使用，且在整个工程中统一F避免使用长的名字（尽量小于25个字母）F避免使用类似的名字，或者仅仅是大小写不同的名字F避免使用下划线（除静态常量等）1.2.示范包（Package）采用完整的英文描述符，应该都是由小写字母组成，格式为com.dcosft.*。如：com.dcsoft.ework.workflowcom.dcsoft.commonscom

4、.dcsoft.utility类（Class）采用完整的英文描述符，所有单词的第一个字母大写，在上下文语境允许的情况下，可以使用缩略词，但必须保证整个开发小组的一致性，比如：number可缩写为num。如：CustomerSavingsAccount接口（Interface）采用完整的英文描述符说明接口封装，所有单词的第一个字母大写。在接口名称的最前面使用大写的“I”表明这是一个接口。习惯上，名字后面加上后缀able，ible或者er，但这不是必需的。如：IContactableIPrompter组件

5、/部件（Component）使用完整的英文描述来说明组件的用途，前端加上组件类型。如：btnOKlstCustomermenuFile异常（Exception）采用异常类型的各单词首字母表示异常。如：ExcpetioneIOExceptionioe字段/属性字段采用完整的英文描述，第一个字母小写，任何中间单词的首字母大写。firstNamelastName实参/参数同字段/属性的命名规则publicvoidsetFirstName(StringfirstName){this.firstName=fir

6、stName;}局部变量同字段/属性的命名规则获取成员函数被访问字段名的前面加上前缀get。getFirstName()getLastName()布尔型的获取成员函数所有的布尔型获取函数必须用单词is做前缀。isPersistent()isString()设置成员函数被访问字段名的前面加上前缀set。setFirstName()setLastName()setWarpSpeed()普通成员函数采用完整的英文描述说明成员函数功能，第一个单词尽可能采用一个生动的动词，第一个字母小写。openFile()a

7、ddAccount()静态常量字段（staticfinal）全部采用大写字母，单词之间用下划线分隔。MIN_BALANCE,DEFAULT_DATE循环计数器通常采用字母i，j，k，m，n或者counter都可以接受。i,j,km,n,counter数组数组数组应该总是用下面的方式来命名：objectType[]variant，注意的地方不得使用objectTypevariant[]方式。int[]arrInt;;String[]args;对象实例同组件/部件byte[]arrBuffer;Strin

8、gBuffersbContent;1.注释约定一个很好的可遵循的有关注释的经验法则是：问问你自己，你如果从未见过这段代码，要在合理的时间内有效地明白这段代码，你需要哪些信息。1.1.一般概念F注释应该增加代码的清晰度F保持注释的简洁F在写代码之前写注释F注释出为什么做了一些事，而不仅仅是做了什么1.2.示范文档注释在紧靠接口、类、成员函数和字段声明的前面注释它们。/**客户：客户是我们将服务和产品卖给的人或机构。*/Stringcustomer;C语言风