JAVA编程规范28128.docVIP

Java编程规范 为什么需要编程规范 在软件的生命周期中，80%的工作是在产品的维护上。 在软件产品的整个生命周期中，它的维护不可能都由产品的开发人员来完成。 良好的编程规范，可以增加程序的可读性，让工程师更好更彻底的理解程序。 当原代码作为产品提交时，需要象其它产品一样，有着良好的包装。 因此，要求开发人员遵守编程规范。 文件的命名 文件后缀 JAVA 源文件后缀为.java; JAVA类文件后缀为.class 公有文件名 编译文件(GNUmakefile)命名为gunmakefile 注释文件名readme 文件的组织 当一个文件有多个部分组成时，应用空行来分隔，并尽可能给出注释。 应尽量避免超过2000行的文件。 Java源代码文件 每个Java原代码文件由一个单独的公共类或接口（interface）组成。当有私有的类或接口与公有的类或接口相关时，可以将它们放在一个文件中。其中的公共类或接口应该是第一个成员。 一个JAVA源文件的组织顺序如下： 起始注释 包声明及导入包声明 类或接口声明 起始注释声明 所有的Java源代码文件均应该包含象C语言那样的起始注释，列出类名，版本信息，日期及版权声明。 如下: /* * 类名称 * * 版本信息 * * 日期 * * 版权声明 */ 包及导入包声明 第一个非注释行应该是包声明，紧接着的是导入包的声明。 如： package java.awt; import java.awt.peer.CanvasPeer; 注意： 通常，包名中第一个组成部分应该是小写的在ISO Standard 3166, 1981标准中公布的顶级域名，如：com，edu，gov，mil，net，org或者是两个字母的国家代码。 类或接口声名 下表描述了一个类或接口声名所需要的的部分，以及它们出现的顺序。 类或接口声明部件 注释 1 类或接口的文档注释（将由JAVADOC生成html文档）（/**…… */） 参考后述章节 2 类或接口声明 3 类或接口实现注释（/* …. */） 应包含在文档注释中未声明的类或接口注释 4 类（静态）变量 按：公共变量，保护变量，私有变量的顺序 5 变量 按：公共变量，保护变量，私有变量的顺序 6 构造函数 7 方法 这些方法应该按功能划分 缩进（indentation） 采用4个空格作为缩进的单元。可用空格键或 TAB键做缩进。TAB键应设为8个空格（不是4个） 行的长度 由于很多的终端设备或编辑工具不好处理超过80个字符的行，所以每行应小于80个字符。 折行处理 如果表达式在一行写不下，则应按以下原则分行： 在逗号以后（comma）分行；如： var = someMethod1(longExpression1, someMethod2(longExpression2, longExpression3)); 在操作符之前分行（operator）； 按运算优先级分行。如： longName1 = longName2 * (longName3 + longName4 - longName5) + 4 * longname6; // PREFER longName1 = longName2 * (longName3 + longName4 - longName5) + 4 * longname6; // AVOID 在同一层次上，表达式的开始处，新行应与前一行对齐； someMethod(longExpression1, longExpression2, longExpression3, longExpression4, longExpression5); 当用以上原则缩进时反而使代码混乱或右边距过小时应往左缩进8个space(即一个TAB)。 如： //CONVENTIONAL INDENTATION（规范的缩进） someMethod(int anArg, Object anotherArg, String yetAnotherArg, Object andStillAnother) { ... } //INDENT 8 SPACES TO AVOID VERY DEEP INDENTS（只缩进8个space以免缩进太深） private static synchronized horkingLongMethodName(int anArg