第八组Java开发编码规范.doc

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

1、项目管理体系文件Java开发编码规范编撰人：TMO审核人：批准人：批准日期：2010-9-1保密级别：机密文档版本：0.0.1北京中软国际信息技术有限公司版本历史日期版本说明作者目录第一章代码开发规范及其指南11.1目的11.2程序内命名规范11.3文件命名规范21.4Java文件样式21.5代码编写格式6第二章程序编写规范方法82.1权限修饰82.2其他规范82.3编程指南10第三章其他要求12第一章代码开发规范及其指南1.1目的定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。（这些

2、规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性）1.2程序内命名规范lPackage的命名：Package的名字应该都是由一个小写单词组成。lClass的命名：Class的名字必须由大写字母开头而其他字母都小写的单词组成lClass变量的命名：变量的名字必须用一个小写字母开头。后面的单词用大写字母开头。lStaticFinal变量的命名：StaticFinal变量的名字应该都大写，并且指出完整含义。l参数的命名：参数的名字必须和变量的命名规范一致。l数组的命名：数组应该总是用下面的方式来命名：byte[]buffer;而不是byte

3、buffer[];l方法的参数：使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字：SetCounter(intsize){this.size=size;}1.1文件命名规范l文件名由英文单词组成，每个单词的首字母大写，不要超过4个单词，如ShipOrder.jsp。lJava文件的文件名要与程序中的public类名相同。lServet文件要以Servlet做为结尾，如AddCompanyServlet.javal业务处理组件JavaBean要以Bean为结尾，如ProcessBean.java1.2Java文件样式所有的Jav

4、a(*.java)文件都必须遵守如下的样式规则l头部版权信息版权信息必须在java文件的开头，比如：/***Copyright2002SunMicrosystems,Inc.Allrightsreserved.*/其他不需要出现在javadoc的信息也可以包含在这里。lPackage/Importspackage行要在import行之前，import中标准的包名要在本地的包名之前，而且按照字母顺序排列。如果import行中包含了同一个包中的不同子目录，则应该用*来处理。packagehotlava.net.stats;importjava.i

5、o.*;importjava.util.Observable;importhotlava.util.Application;这里java.io.*使用来代替InputStreamandOutputStream的。lClass接下来的是类的注释，一般是用来解释类的相关信息，包括标题、描述、。/***

Title:Example

Description:AuditApplicationExample

Copyright:Copyright(c)200x

Company:xxxxx

6、rxxxxxx*@version1.0*/接下来是类定义，包含了在不同的行的extends和implementspublicclassCounterSetextendsObservableimplementsCloneablelClassFields接下来是类的成员变量：/***Packetcounters*/protectedint[]packets;public的成员变量必须生成文档（JavaDoc）。protected、private和package定义的成员变量如果名字含义明确的话，可以没有注释。l存取方法接下来是类变量的存取的方法。

7、它只是简单的用来将类的变量赋值获取值的话，可以简单的写在一行上。/***Getthecounters*@returnanarraycontainingthestatisticaldata.Thisarrayhasbeen*freshlyallocatedandcanbemodifiedbythecaller.*/publicint[]getPackets(){returncopyArray(packets,offset);}publicint[]getBytes(){returncopyArray(bytes,offset);}publici

8、nt[]getPackets(){returnpackets;}publicvoidsetPackets(int[]packets){this.packets=pa