欢迎来到天天文库
浏览记录
ID:41037184
大小:44.50 KB
页数:7页
时间:2019-08-14
《java程序的编程基础规范法则》由会员上传分享,免费在线阅读,更多相关内容在工程资料-天天文库。
1、java程序的编程基础规范法则 定名标准 定义这个标准的方针是让项目中全部的文档都看起来像一整体私人写的,增进可读性,减少项目组中因为换人而带来的丢失。(这些标准并不是一定要绝对死守,但是一定要让法度模范有良好的可读性) Package的定名 Package的名字理当但凡由一个小写单词形成。 Class的定名 Class的名字必须由大写字母开头而其他字母都小写的单词形成 Class变量的定名 变量的名字必须用一个小写字母开头。背面的单词用大写字母开头。 StaticFinal变量的定名 StaticFinal变量的名字理当都大写,并且指出残缺
2、寄义。 参数的定名 参数的名字必须和变量的定名标准差别。 数组的定名 数组理当总是用下面的方式来定名: byte[]buffer; 而不是: bytebuffer[]; 办法的参数 使用居心义的参数定名,假设或许的话,使用和要赋值的字段相同的名字: SetCounter(intsize){ this.size=size; } Java文件格局 全部的Java(*.java)文件都必须死守下列的格局规定 版权信息 版权信息必须在java文件的开头,例如: /** *Copyright®2000ShanghaiXXXCo.Ltd.
3、 *Allrightreserved. */ 其他不需要出当时javadoc的信息也可以收罗在这里。 Package/Imports package行要在import行以前,import中标准的包名要在当地的包名以前,而且按照字母步骤排列。假设import行中收罗了同一个包中的不同子目录,则理当用*来处理。 packagehotlava.net.stats; importjava.io.*; importjava.util.Observable; importhotlava.util.Application; 这里java.io.*使用来包办
4、InputStreamandOutputStream的。 Class 从此的是类的表明,通常为用来表达类的。 /** *Aclassrepresentingasetofpacketandbytecounters *Itisobservabletoallowittobewatched,butonly *reportschangeswhenthecurrentsetiscomplete */ 从此是类定义,收罗了在不同的行的extends和implements publicclassCounterSet extendsObservable im
5、plementsCloneable ClassFields 从此是类的成员变量: /** *Packetcounters */ protectedint[]packets; public的成员变量必须生成文档(JavaDoc)。proceted、private和package定义的成员变量假设名字寄义体味的话,可以不有表明。 存取办法 从此是类变量的存取的办法。它只是简单的用来将类的变量赋值取得值的话,可以简单的写在一行上。 /** *Getthecounters *@returnanarraycontainingthestatistic
6、aldata.Thisarrayhasbeen *freshlyallocatedandcanbemodifiedbythecaller. */ publicint[]getPackets(){returncopyArray(packets,offset);} publicint[]getBytes(){returncopyArray(bytes,offset);} publicint[]getPackets(){returnpackets;} publicvoidsetPackets(int[]packets){this.packets=packe
7、ts;} 其它的办法不要写在一行上 结构函数 从此是结构函数,它理当用递增的方式写(例如:参数多的写在背面)。 接见品种("public","private"等.)和任何"static","final"或"synchronized"理当在一行中,并且办法和参数另写一行,如准许使办法和参数更简单读。 public CounterSet(intsize){ this.size=size; } 克隆办法 假设这个类是可以被克隆的,那么下一步就是clone办法: public Objectclone(){ try{ CounterSetobj
8、=(CounterSet
此文档下载收益归作者所有