JAVA命名规范手册.pdf

'定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。(这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性)Package的命名Package的名字应该都是由一个小写单词组成。Class的命名Class的名字必须由大写字母开头而其他字母都小写的单词组成Class变量的命名变量的名字必须用一个小写字母开头。后面的单词用大写字母开头。StaticFinal变量的命名StaticFinal变量的名字应该都大写，并且指出完整含义。参数的命名参数的名字必须和变量的命名规范一致。数组的命名数组应该总是用下面的方式来命名:byte[]buffer;而不是:bytebuffer[];方法的参数使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字:SetCounter(intsize){this.size=size;}Java文件样式所有的Java(*.java)文件都必须遵守如下的样式规则版权信息版权信息必须在java文件的开头，比如:/***Copyright?0?32000ShanghaiXXXCo.Ltd.*Allrightreserved.*/其他不需要出现在javadoc的信息也可以包含在这里。Package/Imports package行要在import行之前，import中标准的包名要在本地的包名之前，而且按照字母顺序排列。如果import行中包含了同一个包中的不同子目录，则应该用*来处理。packagehotlava.net.stats;importjava.io.*;importjava.util.Observable;importhotlava.util.Application;这里java.io.*使用来代替InputStreamandOutputStream的。Class接下来的是类的注释，一般是用来解释类的。/***Aclassrepresentingasetofpacketandbytecounters*Itisobservabletoallowittobewatched,butonly*reportschangeswhenthecurrentsetiscomplete*/接下来是类定义，包含了在不同的行的extends和implementspublicclassCounterSetextendsObservableimplementsCloneableClassFields接下来是类的成员变量:/***Packetcounters*/protectedint[]packets;public的成员变量必须生成文档(JavaDoc)。proceted、private和package定义的成员变量如果名字含义明确的话，可以没有注释。存取方法接下来是类变量的存取的方法。它只是简单的用来将类的变量赋值获取值的话，可以简单的写在一行上。/***Getthecounters*@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());}}类方法下面开始写类的方法:/***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;i0){i++};//错误,{和}在同一行if(i>0){i++};//正确,{单独作为一行}语句永远单独作为一行.如果}语句应该缩进到与其相对应的{那一行相对齐的位置。 括号左括号和后一个字符之间不应该出现空格,同样,右括号和前一个字符之间也不应该出现空格.下面的例子说明括号和空格的错误及正确使用:CallProc(AParameter);//错误CallProc(AParameter);//正确不要在语句中使用无意义的括号.括号只应该为达到某种目的而出现在源代码中。下面的例子说明错误和正确的用法:if((I)=42){//错误-括号毫无意义if(I==42)or(J==42)then//正确-的确需要括号'