java,编程规范,百度,pdf

1、第1页共 25 页竭诚为您提供优质文档 /双击可除java,编程规范,百度,pdf篇一：java 编程规范_参考java 编码规范制定本编程格式的目的是为了使软件可读性好、兼容性好、易维护等等。注：加(*)者为重要保证要求。一、命名规范l.lpackage 的命名(*)package 的名字应由一个小写单词组成。为了保证包的唯一性，一般以公司国际域名开头。例如：com.elanbase.db1.2class 的命名(*)class 的名字必须由大写字母开头，并且其它单词的首 写字母也要大写。例如：dbaccess。1.3class 成员属性及变量的命名(*)变量/成员属性的名字用一个小写字母开

2、头，后面的单 词以大写字母开头。例如：privatestringlastname;1.4 常量的命名(*)java 里的常量，是用 staticfinal修饰的，应该用全大写加下划线命名，并且常量名应尽量指出完整含义。如：publicstaticfinalstringoRacle_db_dRiVeR=oracle.jdbc. driver.oracledriver;1.5 数组的命名数组应该总是用下面的形式来命名：bytebuffs;而不是：bytebuffs;1.6 方法的参数和变量的命名规范一致，且应使用有意义的参数命名，如果可能的话，使用和要赋值的属性一样的名字，如：setcounter

3、(intsize)this.size=size;1.7 方法命名(*)用一个小写字母开头，后面的单词以大写字母开头。应意义明确，对于属性的存取方法，应使用 getxxx()和 setxxx()名称，以 isxxx() ， hasxxx()来命名返回值为 boolean 类型的方法。1.8 一般命名注意事项第 2 页共 25 页第4页共 25 页a. 用有意义的名字命名变量首先，用完整的英语单词或约定俗成的简写命名变量， 鼓励多用约定俗成的简写命名变量。例如：publicstringzipcodepublicinterrnob. 用复数命名 collection 类变量collection，包括

4、数组，Vector 等。命名时使用复数:例如：publiccollectioncustomers二、java 源文件样式java(*java)源文件应遵守如下的样式规则2.1class 代码布局：packagejavadoc 注释或者其它文件头注释类声明Fields 声明空行构造函数空行第5页共 25 页克隆方法空行其它方法(不包括 main)第6页共 25 页空行内部(inner )类空行main()方法2.2 版权信息版权信息必须在 java 文件的开头，例如：title:编码过滤器description:该类实现把 request 请求编码为文件中所配置的字符集copyright:cop

5、yright(c)20 xxcompany:华软软件学院*authorweiowen*version1.0*/2.3package/imports(*)/*web.xml第7页共 25 页package 行要在版权信息之前，中间空一行将 import 的 classes 归类，按顺序罗列：a. java 标准类(java.*)b. java 扩充类(javax.*)c. 第三方类d. 你的应用程序的类每一类空一行。注意在第三方类里进行注释，说明它们的来源。如果 import 行中包含了同一个包中的多个类，不推荐用 importpakage.* 来处理，推荐把要用的类一一import 出来这样程

6、序用到哪些类就可以非常清楚的看出来，有利于代码 的维护，增强了代码的可读性。例如：importjava.util.observable;importjava.util.date;importjavax.sql.connection;/apachexercesimportorg.apache.xml.*;importorg.apache.xerces.dom.*;/applicationclassesimportcom.elanbase.db.dbaccess2.4classFields第8页共 25 页类的成员变量：packetcounters第 6 页共 25 页*/ protectedin

7、tpackets;public 的成员变量必须以生成文档(javadoc )的方式进行注释(/* */ )。protected 、private 和 package 定义的成员变量如果名字含义明确的话，可以没有注释。Field 定义可遵从以下顺序：a. public 常量b. public 变量c. protected 常量d. protected 变量e. package 常量f. package 变量g. private 常量h. private 变量2.5 存取方法(getter ， setter)接下来是类成员变量的存取的方法。2.6 构造方法(*)重载的构造方法应该用递增的方式写(参

8、数多的写在后面)。publiccounterset()this(10);第10页共 25 页publiccounterset(intsize)this.size=size;2.7 克隆方法如果这个类是可以被克隆的，就应实现clone 方法:publicobjectclone()trycountersetobj=(counterset)super.clone();obj.packets=(int)packets.clone();obj.size=size;returnobj;catch(clonenotsupportedexceptione)thrownewinternalerror(unexp

9、ectedclonenotsupportede xception:+e.getmessage();2.8 类方法下面开始写类方法：setthepacketcounters*(suchaswhenrestoringfromadatabase)*/第11页共 25 页protectedfinalvoidsetarray(intr1,intr2,intr3,intr4)throwsillegalargumentexception/ensurethearraysareofequalsize/if(r1.length!=r2.length|r1.length!=r3.length|r1.l ength!

10、=r4.length)thrownewillegalargumentexception(arraysmustbeofthe samesize);system.arraycopy(r1,0,r3,0,r1ength);system.arraycopy(r2,0,r4,0,r1ength);2.9tostring 方法每一个类都最好定义tostring 方法：publicstringtostring()stringretval=counterset:;篇二：20 xxjava 语言编程规范dkba华为技术有限公司企业技术规范第12页共 25 页dkbaxxxx-20 xx.12代替(dkba20

11、xx06-003 )java 语言编程规范20 xx-12-xx 发布 20 xx-12-xx 实施华为技术有限公司发布VVVVVVVVVVVVVVVVVVxxVx.xVx.xVx.xVx.xVx.x目次31 范围2 规范性引用文件 3 术语和定义 4 排版规范4.1 规则1. *程序块要采用缩进风格编写，缩进的空格数为2. *分界符（如大括号 和 应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case 语句中的程序都要采用如上的缩进方式。3.*较长的语第13页共 25 页句、表达式或参数（80 字符）

12、要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。4.*不允许把多个短语句写在一行中，即一行只写一条语句5. *if,for,do,while,case,switch,default等语句自占一行，且 if,for,do,while 等语句的执行语句无论多少都 要加括号。6. *相对独立的程序块之间、变量说明之后必须加空行。7. *对齐只使用空格键，不使用 tab 键。2111111121212121313131314VVVVVVV VVVVVVVVVVVxxVx.xVx.xVx.xVx.xVx.x8.*在两个以上的关

13、键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对 等操作时，如果是关系密切的立即操作符（如 .），后不应加空格。4.2 建议第14页共 25 页1.类属性和类方法不要交叉放置，不同存取范围的属性 或者方法也尽量不要交叉放置。5 注释规范5.1 规则1. 一般情况下，源程序有效注释量必须在30 %以上。2. 包的注释：包的注释写入一个名为 package.html 的 html 格式的说明文件放入当前路径。3.包的注释内容：简述 本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。4.文件注释：文件注释写入文件头部， 包名之前的位置。5. 文件注释内

14、容：版权说明、描述信息、生成日期、修改历 史。6.类和接口的注释：该注释放在 package关键字之后，class 或者 interface 关键字之前。7.类和接口的注释内容： 类的注释主要是一句话功能简述、功能详细描述，8.类属性、公有和保护方法注释：写在类属性、公有和保护方法上面。9. 成员变量注释内容：成员变量的意义、目的、功能，可能 被用到的地方。10.公有和保护方法注释内容：列出方法的 一句话功能简述、功能详细描述、输入参数、输出参数、返 回值、违例等。3141515第15页共 25 页161616161616171818191919VVVVVVVVVVVVVVVVVVxxVx.x

15、Vx.xVx.xVx.xVx.x11. 对于方法内部用 throw 语句抛出的异常，必须在方法的注释中标明，对于所调用的其他方法所抛出的异常，选择主要的在注释中说明。对于非Runtimeexception ，即throws 子句声明会抛出的异常，必须在方法的注释中标明。12. *注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。13. *注释与所描述内容进行同样的缩排。14. *将注释与其上面的代码用空行隔开。15. *对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。16.*对于 switch 语句下的 case 语句，如果因为特殊情况需要处理完一个case 后进入下一个 case 处理，3141515第16页共 25 页必须在该 case 语句处理完、下一个 case 语句前加上明确的第17页共 25 页注释。17.*边写代码边注释，修改代码同时修改相应的注释， 以保证注释与代码的一致性。不再有用的注释要删除。18.*注释的内容要清楚、明了，含义准确，防止注释二义性。19.*避免在注释中使用