java编程规范92646

《java编程规范92646》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、JAVA编程规范上海XX信息技术有限公司-10-上海XX信息技术有限公司修订记录-10-上海XX信息技术有限公司目录JAVA编程规范-1-1命名规范-4--10-上海XX信息技术有限公司1命名规范定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。(这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性)　　Package的命名　　Package的名字应该都是由一个小写单词组成。　　Class的命名　　Class的名字必须由大写字母开头而其他字母都小写的单词组成　　Class变量的命名　　变量的名字必须用一个小写字母开头。后

2、面的单词用大写字母开头。　　StaticFinal变量的命名　　StaticFinal变量的名字应该都大写，并且指出完整含义。　　参数的命名　　参数的名字必须和变量的命名规范一致。　　数组的命名　　数组应该总是用下面的方式来命名:　　byte[]buffer;　　而不是:　　bytebuffer[];　　方法的参数　　使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字:　　setCounter(intsize){　　this.size=size;　　}　　Java文件样式　　所有的Java(*.java)文件都必须遵守如下的样式规则　　版权信息　　版权信息必须在java

3、文件的开头，比如:　　/**　　*Copyright®2000ShanghaiXXXCo.Ltd.　　*Allrightreserved.　　*/　　其他不需要出现在javadoc的信息也可以包含在这里。　　Package/Imports　　package行要在import行之前，import中标准的包名要在本地的包名之前，而且按照字母顺序排列。如果import行中包含了同一个包中的不同子目录，则应该用*来处理。　　packagehotlava.net.stats;　　importjava.io.*;　　importjava.util.Observable;　　importhotla

4、va.util.Application;　　这里java.io.*使用来代替InputStreamandOutputStream的。　　Class-10-上海XX信息技术有限公司　　接下来的是类的注释，一般是用来解释类的。　　/**　　*Aclassrepresentingasetofpacketandbytecounters　　*Itisobservabletoallowittobewatched,butonly　　*reportschangeswhenthecurrentsetiscomplete　　*/　　接下来是类定义，包含了在不同的行的extends和implements　

5、　publicclassCounterSet　　extendsObservable　　implementsCloneable　　ClassFields　　接下来是类的成员变量:　　/**　　*Packetcounters　　*/　　protectedint[]packets;　　public的成员变量必须生成文档(JavaDoc)。proceted、private和package定义的成员变量如果名字含义明确的话，可以没有注释。　　存取方法　　接下来是类变量的存取的方法。它只是简单的用来将类的变量赋值获取值的话，可以简单的写在一行上。　　/**　　*Getthecounters　　*

6、@returnanarraycontainingthestatisticaldata.Thisarrayhasbeen　　*freshlyallocatedandcanbemodifiedbythecaller.　　*/　　publicint[]getPackets(){returncopyArray(packets,offset);}　　publicint[]getBytes(){returncopyArray(bytes,offset);}　　publicint[]getPackets(){returnpackets;}　　publicvoidsetPackets(int[]pa

7、ckets){this.packets=packets;}　　其它的方法不要写在一行上　　构造函数　　接下来是构造函数，它应该用递增的方式写(比如:参数多的写在后面)。　　访问类型("public","private"等.)和任何"static","final"或"synchronized"应该在一行中，并且方法和参数另写一行，这样可以使方法和参数更易读。　　public　　CounterSet(intsize){　　this.size=size;　　}