欢迎来到天天文库
浏览记录
ID:18619554
大小:77.50 KB
页数:11页
时间:2018-09-19
《java编程规范28293》由会员上传分享,免费在线阅读,更多相关内容在教育资源-天天文库。
1、四川结盟科技有限公司Java编程规范JAVA编程规范大全 四川结盟科技有限公司2010年1月四川结盟科技有限公司Java编程规范命名规范 定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。(这些规范并不是一定要绝对遵守,但是一定要让程序有良好的可读性) 1.1Package的命名Package的名字应该都是由一个小写单词组成。1.2Class的命名Class的名字必须由大写字母开头而其他字母都小写的单词组成1.3Class变量的命名变量的名字必须用一个小写字母开头。后
2、面的单词用大写字母开头。1.4StaticFinal变量的命名StaticFinal变量的名字应该都大写,并且指出完整含义。1.5参数的命名参数的名字必须和变量的命名规范一致。1.6数组的命名数组应该总是用下面的方式来命名:byte[]buffer;而不是:bytebuffer[];1.7方法的参数使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字: SetCounter(intsize){ this.size=size; }四川结盟科技有限公司Java编程规范Java文件样式所有的Java(*.java)文
3、件都必须遵守如下的样式规则1.1版权信息版权信息必须在java文件的开头,比如:/***Copyright®2000ShanghaiXXXCo.Ltd.*Allrightreserved.*/其他不需要出现在javadoc的信息也可以包含在这里。1.2Package/Imports package行要在import行之前,import中标准的包名要在本地的包名之前,而且按照字母顺序排列。如果import行中包含了同一个包中的不同子目录,则应该用*来处理。 packagehotlava.net.stats; importja
4、va.io.*; importjava.util.Observable; importhotlava.util.Application;这里java.io.*使用来代替InputStreamandOutputStream的。1.3Class接下来的是类的注释,一般是用来解释类的。/***Aclassrepresentingasetofpacketandbytecounters*Itisobservabletoallowittobewatched,butonly*reportschangeswhenthecurrentseti
5、scomplete*/接下来是类定义,包含了在不同的行的extends和implementspublicclassCounterSetextendsObservableimplementsCloneable1.4ClassFields接下来是类的成员变量:/***Packetcounters*/protectedint[]packets; public的成员变量必须生成文档(JavaDoc)。proceted、private和package定义的成员变量如果名字含义明确的话,可以没有注释。 四川结盟科技有限公司Java编程规
6、范存取方法 接下来是类变量的存取的方法。它只是简单的用来将类的变量赋值获取值的话,可以简单的写在一行上。 /** *Getthecounters *@returnanarraycontainingthestatisticaldata.Thisarrayhasbeen *freshlyallocatedandcanbemodifiedbythecaller. */ publicint[]getPackets(){returncopyArray(packets,offset);} publicint[]getByte
7、s(){returncopyArray(bytes,offset);} publicint[]getPackets(){returnpackets;} publicvoidsetPackets(int[]packets){this.packets=packets;}其它的方法不要写在一行上1.1构造函数 接下来是构造函数,它应该用递增的方式写(比如:参数多的写在后面)。 访问类型("public","private"等.)和任何"static","final"或"synchronized"应该在一行中,并且方法和参数另写
8、一行,这样可以使方法和参数更易读。PublicCounterSet(intsize){ this.size=size;}1.2克隆方法 如果这个类是可以被克隆的,那么下一步就是clone方法:PublicObjectclone(){ try{ Count
此文档下载收益归作者所有