java平台代码编写规范

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

1、代码编写规范目录前言5编写目的5命名规范51Package的命名5Class的命名6Class变量的命名6接口的命名7参数的命名7数组的命名7方法的参数命名7注释规范71实现注释的格式(ImplementationCommentFormats)83」」块注释(BlockComments)8单行注释(Single・LineComments)9尾端注释(TrailingComments)9行末注释(End・Of・LineComments)9Java文件样式101版权信息102Packagc/Imports103Class

2、114.4ClassFields114.5存取方法124.6构造函数124.克隆方法134.类方法134.9main方法14代码编写格式14代码样式14文档化14缩进14页宽14{}对15括号15JAVA编码规范156.1注意15异常处理16垃圾收集16Clone17final类176.6访问类的成员变量18编写类的公共问题18JSP编码规范19代码编译20匈牙利命名规则219.1数据类型缩写219.2SWING一些控件的缩写219.3SWT-些控件的缩写229.4方法22部分编程常用单词缩写22编程技巧2411.1

3、byte数组转换到characters24Utility类24初始化24枚举类型2411.5bytc[]中的值2511.6String和StringBuffer25调试25性能251前言1・1编写目的1、采用J2EE框架，基于J2EE的JSP>Servlet的MVC模式。采用Struts.Hibernate^Spring等框架2、Web服务器釆用Tomcat或JBOSS。3^使用Eclipsc^Dreamweaver相关开发工具。4、J2SE采用JavaAWT、多线程、SWING、JDBC等相关技术。本规范是本项目组

4、开发人员必须遵循的，可供测试等其他人员参考，本规范只适合本项目组内部使用。特别注意1、所有需要等待的程序加上进度条；2、所有的方法加上javadoc注释，重要变量和属性也加上注释说明；3、代码必须进行格式化，以使代码可读性强；2命名规范定义命名规范的目的是让项目中所有的文档看起来都像一个人写的，增加可读性，减少项目组中因为换人而带来的损失（这些规范并不是一定耍绝对遵守，但是一定要让程序有良好的可读性）。1Package的命名包名的后续部分根据不同机构、不同项目的命名规范而不尽相同，尽量清晰,易懂，容易理解。2Clas

5、s的命名Class的名字必须由大写字母开头、而其他字母都小写的单词组成。尽量使类名简洁而有含义。使用完整单词，避免缩写词（除非该缩写词被更广泛使用，像URL,HTML）o如hclassRaster^classImageSprite□3Class变量的命名除了变量名外，所有实例，包括类，类常量，均采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。变量名不应以下划线或美元符号开头，尽管这在语法上是允许的。变量名应简洁而有含义。变量名的选用应该易于记忆，即能够指出其用途。尽量避免单个字符的变量名，除非是一

6、次性的临时变量。临时变量通常被取名为i,j,k,m和n,它们一般用于整型；c,d,e,它们一般用于字符型。如chare、inti>floatmyWidtho实例变量InstanceVariables)大小写规则和变量名相似。常量（Constants）类常量和ANSI常量的声明，应该全部大写，单词间用下划线隔开（尽量避免ANSI常量，容易引起错误）。女山staticfinalintMIN_WIDTH=4、staticfinalintMAX_WIDTH=999、staticfinalintGET_THE_CPU=1。除了

7、以下几个特例之外，命名时应始终采用完整的英文描述符。此外，一般应采用小写字母，但类名、接口名以及任何非初始单词的第一个字母要大写。1、尽量使用完整的英文描述符；2、釆用适用于相关领域的术语；3、采用大小写混合使名字可读；4、尽量少用缩写，但如果用了，要明智地使用，且在整个工程中统一；5、避免使用长的名字（小于15个字母）；6、避免使用类似的名字，或者仅仅是大小写不同的名字；7、避免使用下划线。2・4接口的命名大小写规则与类名相似，如：interfaceRasterDelegate>interfaceStoringo方

8、法(Methods)名采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。如:run()^runFast()^getBackground()o3.1.25参数的命名参数的名字必须和变量的命名规范一致。6.76数组的命名数组应该总是用下面的方式来命名:2.7方法的参数命名使用有意义的参数命名，如果可能的话，使用和耍赋值的字段一样的