Java编码规范VIP免费

1.引言编码规范对于软件而言非常重要，有以下几个原因：■一个软件的生命周期中，80%的花费在于维护■几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护■编码规范可以改善代码的可读性，可以让程序员尽快而彻底地理解新的代码■发布产品时容易打包为了执行规范，每个软件开发人员必须一致遵守编码规范。2.文件组织结构每个Java源文件都只包含一个单一的公共类（接口）；若私有类（接口）与一个公共类（接口）关系比较密切，可以将它们和公共类（接口）放入同一个源文件；公共类（接口）必须是这个文件中的第一个类（接口）。建议按照如下顺序组织Java文件：一、版权声明，如下所示：////Copyright（C）2006GWSSICORPORATION////ALLRIGHTSRESERVEDBYGWSSICORPORATION,THISPROGRAMUMUSTBEUSEDSOLELYFORTHEPURPOSEFORWHICHITWAS//FURNISHEDBYGWSSICORPORATION,NOPARTOFTHISPROGRAM//MAYBEREPRODUCEDORDISCLOSEDTOOTHERS,INANYFORM//WITHOUTTHEPRIORWRITTENPERMISSIONOFGWSSICORPORATION.//USEOFCOPYRIGHTNOTICEDOESNOTEVIDENCEPUBLICATION//OFTHEPROGRAM//UGWSSICONFIDENTIALANDPROPRIETARY//////////////////////////////////////////////////////////////////////////////U二、版本信息：可以使用版本管理工具自动管理，例如CVS,只要我们在Java文件中添加〃$Log$关键字，每次向CVSServer提交的时候，就会进行关键字替换：//版本号提交日期提交人（CVS用户名）//提交时填入的备注信息，如修改原因////$Log:ClassTemplate.java,v$//Revision1.32006/11/2011:54:44administrator"为T更好的演示gve交件第枸，帳抑了实例变昼////Revision1.22006/11/2011:54:18administrator"新建//三、package声明四、import语句：♦顺序：>java>javax>org>com>cn♦每个顶级包之间有空行♦为了增强代码可读性，每一个import语句引入一个类，尽量不要出现.*的import语句，如下图：importjava・Lu.Inpiit.St.rp；3ni；imi)ortjava・ut.i1.ArrayList.;importjavax„servlet.nServlet.Except.ion;importjavax„servlet.„Unavail；5ilj1&EKCEption;importjavax«servlet.nhtt.p・Hr.t.pServlet.Request.;importjavax„servlet.nhtt.p・Ht.t.pServlet.Response;importo匚gr・ache・1口g4i・Lugger;importc口・gussi■亡uiTiinu口■匚unipone门匸.Config;importc口・giijs曰i・匚uiTiinun・cunipone门匸.TxnC□nst.ant.s;importcti・giijssi.亡niYiinn门・cnnipnnent・except.Lon・TxnException;importc口・gussi■亡uiTiinu口■匚unipone门匸.丄口gger„TxnLogger;importc口・giijs曰i・匚uiTiinun・cunipone门匸.moduleaModu1eConfig;Importcti・giijssi.亡niYiinn门・cnnipnnent・meduleaModu1eDat.aFile;在Eclipse中可以使用ctrl+shift+o来重新组织import语句。五、类（接口）文档注释：六、类（接口）声明七、类变量>public>protected>无限定修饰符，包内可见>private八、实例变量>public>protected>无限定修饰符，包内可见>private九、构造函数十、成员方法为了增强代码的可读性，成员方法应该按功能，而非作用域或访问权限分组。例如,个私有的类方法可以置于两个公有的实例方法之间。一个Java文件中包含多个类(接口)，那么重复“五9十”部分3.注释描述Java程序有两类注释：■实现注释(implementationcomments)：与C++使用的注释相似，使用/*...*/和〃界定的注释，用作临时注销代码或者注释实现细节。■文档注释(documentcomments):是Java独有的，并由/**...*/界定，从实现自由(implementation-free)的角度描述代码的规范，文档注释可以通过javadoc工具转换成HTML文件，被那些手头没有源码的开发人员使用。3・1•实现注释程序可以有4种实现注释的风格：块(block)、单行(single-line)、尾端(trailing)和行末(end-of-line)。3・1・1・块注释块注释通常用于提供对文件、方法、数据结构和代码段的描述。块注释通常被置于被注释的对象(文件、方法、数据结构和代码段)前面，应该和它要注释的对象具有一样的缩进。块注释之前应该有一个空行，用于把块注释和代码分割开来，比如：*Hereisablo...