Java代码编写规范.pptVIP

JAVA代码规范 用友政务软件有限公司 2009年12月 为什么要有编码规范 编码规范对于程序员而言尤为重要，有以下几个原因： - 一个软件的生命周期中，80%的花费在于维护- 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护- 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码- 如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误。 文件后缀 Java程序使用下列文件后缀： ?文件类别 文件后缀 ? Java源文件 .java ? Java字节码文件 .class 文件组织 一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成 超过2000行的程序难以阅读，应该尽量避免 每个Java源文件都包含一个单一的公共类或接口.若私有类和接口与一个公共类相关联，可以将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。 开头注释 所有的源文件都应该在开头有一个C语言风格的注释，其中列出类名、版本信息、日期和版权声明 ,例如： /* * Classname * * Version info * * Copyright notice */ 缩进排版 4个空格常被作为缩进排版的一个单位。缩进的确切解释并未详细指定(空格 vs. 制表符)。一个制表符等于8个空格(而非4个)。 行长度 尽量避免一行的长度超过80个字符，因为很多终端和 工具不能很好处理之。 注意 用于文档中的例子应该使用更短的行长，长度一般不超过70个字符 换行 当一个表达式无法容纳在一行内时，可以依据如下一般规则断开之： - 在一个逗号后面断开- 在一个操作符前面断开- 宁可选择较高级别(higher-level)的断开，而非较低级别(lower-level)的断开- 新的一行应该与上一行同一级别表达式的开头处对齐- 如果以上规则导致你的代码混乱或者使你的代码都堆挤在右边，那就代之以缩进8个空格。 换行（例子） 以下是断开方法调用的一些例子： function(longExpression1, longExpression2, longExpression3, longExpression4, longExpression5); var = function1(longExpression1, function2(longExpression2, longExpression3)); 断开方法调用的一些例子 if语句的换行通常使用8个空格的规则，因为常规缩进(4个空格)会使语句体看起来比较费劲，例如： if ((condition1 condition2) || (condition3 condition4) ||!(condition5 condition6)) { //BAD WRAPS doSomethingAboutIt(); //MAKE THIS LINE EASY TO MISS } 断开方法调用的一些例子 推荐使用如下的断开方式 if ((condition1 condition2) || (condition3 condition4) || ! (condition5 condition6)) { doSomethingAboutIt(); } //或者使用如下方式 if ((condition1 condition2) || (condition3 condition4) || ! (condition5 condition6)) { doSomethingAboutIt(); } 注释 注释应被用来给出代码的总括，并提供代码自身没有提供的附加信息。 注释应该仅包含与阅读和理解程序有关的信息。例如，相应的包如何被建立或位于哪个目录下之类的信息不应包括在注释中 注释 Java程序有两类注释：实现注释和文档注释。 实现注释是那些在C++中见过的，使用/*...*/和//界定的注释 文档注释是Java独有的，并由