第八组Java开发编码规范

项目管理体系文件Java开发编码规范编撰人：TMO审核人：批准人：批准日期：2010-9-1保密级别：机密文档版本：0.0.1北京中软国际信息技术有限公司Java开发编码规范第2页版本历史日期版本说明作者Java开发编码规范第1页目录第一章代码开发规范及其指南.............................................................................................................11.1目的...............................................................................................................................................11.2程序内命名规范............................................................................................................................11.3文件命名规范...............................................................................................................................21.4JAVA文件样式...............................................................................................................................21.5代码编写格式...............................................................................................................................6第二章程序编写规范方法.....................................................................................................................82.1权限修饰.......................................................................................................................................82.2其他规范.......................................................................................................................................82.3编程指南.....................................................................................................................................10第三章其他要求...................................................................................................................................12Java开发编码规范第1页第一章代码开发规范及其指南1.1目的定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。（这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性）1.2程序内命名规范Package的命名：Package的名字应该都是由一个小写单词组成。Class的命名：Class的名字必须由大写字母开头而其他字母都小写的单词组成Class变量的命名：变量的名字必须用一个小写字母开头。后面的单词用大写字母开头。StaticFinal变量的命名：StaticFinal变量的名字应该都大写，并且指出完整含义。参数的命名：参数的名字必须和变量的命名规范一致。数组的命名：数组应该总是用下面的方式来命名：byte[]buffer;而不是bytebuffer[];方法的参数：使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字：SetCounter(intsize){this.size=size;}Java开发编码规范第2页1.3文件命名规范文件名由英文单词组成，每个单词的首字母大写，不要超过4个单词，如ShipOrder.jsp。Java文件的文件名要与程序中的public类名相同。Servet文件要以Servlet做为结尾，如AddCompanyServlet.java业务处理组件JavaBean要以Bean为结尾，如ProcessBean.java1.4Java文件样式所有的Java(*.java)文件都必须遵守如下的样式规则头部版权信息版权信息必须在java文件的开头，比如：/***Copyright2002SunMicrosystems,Inc.Allrightsreserved.*/其他不需要出现在javadoc的信息也可以包含在这里。Package/Importspackage行要在import行之前，import中标准的包名要在本地的包名之前，而且按照字母顺序排列。如果import行中包含了同一个包中的不同子目录，则应该用*来处理。packagehotlava.net.stats;importjava.io.*;importjava.util.Observable;importhotlava.util.Application;Java开发编码规范第3页这里java.io.*使用来代替InputStreamandOutputStream的。Class接下来的是类的注释，一般是用来解释类的相关信息，包括标题、描述、。/***pTitle:Example/p*pDescription:AuditApplicationExample/p*pCopyright:Copyright(c)200x/p*pCompany:xxxxx/p*@authorxxxxxx*@version1.0*/接下来是类定义，包含了在不同的行的extends和implementspublicclassCounterSetextendsObservableimplementsCloneableClassFields接下来是类的成员变量：/***Packetcounters*/protectedint[]packets;public的成员变量必须生成文档（JavaDoc）。protected、private和package定义的成员变量如果名字含义明确的话，可以没有注释。存取方法接下来是类变量的存取的方法。它只是简单的用来将类的变量赋值获取值的话，可以简单的写在一行上。/***GetthecountersJava开发编码规范第4页*@returnanarraycontainingthestatisticaldata.Thisarrayhasbeen*freshlyallocatedandcanbemodifiedbythecaller.*/publicint[]getPackets(){returncopyArray(packets,offset);}publicint[]getBytes(){returncopyArray(bytes,offset);}publicint[]getPackets(){returnpackets;}publicvoidsetPackets(int[]packets){this.packets=packets;}其它的方法不要写在一行上构造函数接下来是构造函数，它应该用递增的方式写（比如：参数多的写在后面）。访问类型(public,private等.)和任何static,final或synchronized应该在一行中。PublicCounterSet(intsize){this.size=size;}克隆方法如果这个类是可以被克隆的，那么下一步就是clone方法：publicObjectclone(){try{CounterSetobj=(CounterSet)super.clone();obj.packets=(int[])packets.clone();obj.size=size;returnobj;}catch(CloneNotSupportedExceptione){thrownewInternalError(UnexpectedCloneNotSUpportedException:+e.getMessage());}}Java开发编码规范第5页类方法下面开始写类的方法：/***Setthepacketcounters*(suchaswhenrestoringfromadatabase)*/protectedfinalvoidsetArray(int[]r1,int[]r2,int[]r3,int[]r4)throwsIllegalArgumentException{////Ensurethearraysareofequalsize//if(r1.length!=r2.length||r1.length!=r3.length||r1.length!=r4.length)thrownewIllegalArgumentException(Arraysmustbeofthesamesize);System.arraycopy(r1,0,r3,0,r1.length);System.arraycopy(r2,0,r4,0,r1.length);}toString方法无论如何，每一个类都应该定义toString方法：publicStringtoString(){Stringretval=CounterSet:;for(inti=0;idata.length();i++){retval+=data.bytes.toString();retval+=data.packets.toString();}returnretval;}}Java开发编码规范第6页main方法如果main(String[])方法已经定义了,那么它应该写在类的底部.1.5代码编写格式代码样式代码应该用unix的格式，而不是windows的（比如：回车变成回车+换行）文档化必须用javadoc来为类生成文档。不仅因为它是标准，这也是被各种java编译器都认可的方法。缩进缩进应该是每行4个空格.不要在源文件中保存Tab字符.在使用不同的源代码管理工具时Tab字符将因为用户设置的不同而扩展为不同的宽度.如果你使用UltraEdit作为Java源代码编辑器的话，你可以通过如下操作来禁止保存Tab字符,方法是通过UltrEdit中先设定Tab使用的长度是4个空格，然后用Format|TabstoSpaces菜单将Tab转换为空格。页宽页宽应该设置为80字符.源代码一般不会超过这个宽度,并导致无法完整显示,但这一设置也可以灵活调整.在任何情况下,超长的语句应该在一个逗号或者一个操作符后折行.一条语句折行后,应该比原来的语句再缩进2个字符.程序块要有大括号，即使只有一句程序{}中的语句应该单独