Java程序设计修改-fl02.docVIP

附录2 Java语言编码规范 附2.1 介绍 附2.1.1 为什么要有编码规范 编码规范对于程序员而言尤为重要，有以下几个原因： 可读性：编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码 规范性：编码规范可以提高代码的规范性，使程序逻辑更加清晰 可维护性：一个软件的生命周期中，80%的花费在于维护；几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护 产品发布：如果你将源码作为产品发布，就需要确认它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品 为了执行规范，每个软件开发人员必须一致遵守编码规范。 附2.1.2 参考资料 本文档Sun MicroSystems公司，Java语言规范中的编码标准部分。/docs/codeconv/html/CodeConvTOC.doc.html 附2.2 文件名 文件后缀 Java程序使用下列文件后缀： Java源文件：.java Java编译后的字节码文件：.class MANIFEST.MF：.MF，包配置的说明文件。 XML配置文件：.xml 属性配置文件：.property Jar文件：.jar Java源文件还遵循以下规则： 开头注释(Beginning Comments) 包和引入语句(Package and Import Statements) 类和接口声明(Class and Interface Delarations) 1.开头注释 所有的源文件都应该在开头有一个的注释，其中列出类名、版本信息、日期和版权声明： /** *@classname: AdminBO 管理员信息业务类 *@author 李小刚 *@serialData 07-2-15 *@version 1.0.0 */ 2.包和引入语句 在多数Java源文件中，第一个非注释行是包语句，在它之后可以跟引入语句。例如： package java.awt; import java.awt.peer.CanvasPeer; 3.类和接口说明(Class and Interface Delarations) 类和接口声明的各个部分出现的先后次序类/接口JavaDoc注释/**......*/）。 类或接口的声明。 类/接口实现的注释/*......*/），如果有必要的话该注释应包含任何有关整个类或接口的信息，而这些信息又不适合作为类/接口文档注释。 类的静态变量首先是公共变量，随后是保护protected）变量，再后是包级别的变量没有访问修饰符的，默认为friendly，最后是私有private）变量。 实例变量首先是公共变量，随后是保护protected）变量，再后是包级别的变量没有访问修饰符的，默认为friendly，最后是私有private）变量。 构造函数 方法，这些方法应该按功能，而非作用域或访问权限，分组。例如，一个私有的类方法可以置于两个公有的实例方法之间。其目的是为了更便于阅读和理解代码。 main()函数，如果有main函数的话，则放在类的最后。 exit() 除了在 main() 中可以被调用外，其他的地方不应该调用。因为这样做不给任何代码机会来截获退出。一个类似后台服务地程序不应该因为某一个库模块决定了要退出就退出。 /** * 添加管理员信息 * @param adminInfo AdminInfo 管理员类值对象 * @return void */ public void addAdminInfo(AdminInfo adminInfo){ } 附2.4 缩进排版(Indentation) 我们规定，4个空格常被作为缩进排版的一个单位（一个TAB键）someMethod(longExpression1, longExpression2, longExpression3, longExpression4, longExpression5); var = someMethod1(longExpression1, someMethod2(longExpression2, longExpression3)); longName1 = longName2 * (longName3 + longName4 - longName5) + 4 * longname6; //PREFFER 附2.5 注释 注释的规范： 注释目的：注释应该使你的代码更清晰，增强程序的可读性和可维护性。 数量标准：注释应占程序代码的比例达到20%左右，即100行程序中包含20行左右的注释。 概括性：注释应被用来给出代码的总括以及代码自身没有提供的附加信息