[10]Java代码基本规范.doc

Java编码基本规范
注：本文档只关注java的基本规范，至于项目中的组织结构等的规范请参阅dev_guid.doc
开始
为什么要有编码规范
编码规范对于程序员而言尤为重要，有以下几个原因：
◆一个软件的生命周期中，80%的花费在于维护。
◆几乎没有任何一个软件，在其整个生命同期中，均由最初的开发人员来维护。
◆编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新代码。
◆如果你将源码作为产品发布，就需要确认它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品。
为了执行规范，每个软件开发人员必须一致遵守编码规范。每个人!!!
文件名
这部分列出了常用的文件名及其后缀。
文件后缀(FileSuffixes)
Java程序使用下列文件后缀：
文件类别文件后缀Java源文件.javaJava字节码文件.class
常用文件名(CommonFileNames)
常用的文件名包括：
文件名用途GNUmakefilemakefiles的首选文件名。我们采用gnumake来创建(build)软件。README概述特定目录下所含内容的文件的首选文件名。文件组织(FileOrgnization)
一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过2000行的程序难以阅读，应该尽量避免。“Java源文件范例”提供了一个页面布局合理的Java程序范例。
Java源文件(JavaSourceFiles)
每个Java源文件都包含一个单一的公共类或接口。
若私有类和接口与一个公共类相关联。可以将它们和公共类放入同个源文件。公共类必须是这个文件中的第一个类和接口。
Java源文件还遵循以下规则：
◆开头注释(参见“开头注释”)
◆包和引入语句(参见“包和引入语句)
◆类和接口声明(参见“类和接口声明)
开头注释(BeginningComments)
所有的源文件都应该在开头有一个C语言风格的注释，其中列出数出类名、版本信息，日期和版权声明：
/**
*Function:TODO
*FileName.java
*FileCreatedon2011-3-30
*@Version1.0
*
*Copyright2009baidu.com
*Allrightsreserved.
*/
包和引入(PackageandImportStatements)
在多数Java源文件中，第一个非注释行是包语句行。在它之后可以跟引入语句。例如：
packagejava.awt;
importjava.awt.peer.CanvasPeer;
类和接口声明(ClassandInterfaceDeclarations)
下表描述了类和接口声明的免修部分以及它们出现的先后次序。
类/接口声明的各部分注解1类/接口文档注释
(/**…*/)该注释中所包含的信息，参见“文档注释”2类/接口的声明3类/接口实现的注释
(/*…*/)
如果有必要的话该注释应包含任何有关整个类或接口的信息，而这些信息又适合作为类/接口文档注释。4类的(静态)变量首先是类的public变量，随后是protected变量，再后是包一级别的变量(没有访问修饰符)，最后是private变量。5实例变量首先是public变量，随后是protected变量，再后是包一级别的变量(没有访问修饰符)，最后是private变量。6构造器7方法这些方法应该按功能，而非作用域或访问权限，分组。缩进排版(Indentation)
4个空格常被作为缩进排版的一个单位。严禁使用“tab”缩进（eclipse中可以将tab键自动转换为空格）。
行长度
尽量避免一行长度超过80个字符，因为很多终端和工具不能很好处理之。注意：用于文档是的例子应该使用更短的行长，长度一般不超过70个字符。
换行(WrappingLines)
当一个表达式无法容纳在一行内时，可以依据如下一般规则断开之：
◆在一个逗号后面断开。
◆在一个操作符前面断开。
◆宁可选择较高级别的(higher-level)的断开，而非较低级别(lower-level)的断开。
◆新的一行应该与上一行同一级别表达式的开头处对齐。
◆如果以上规则导致你的代码混乱或者使你的代码都堆挤在右边，那就代之以缩进8个空格。
以下是断开方法的一些例子：
someMethod(longExpression1,longExpression2,longExpression3,
longExpression4,longExpression5);
var=someMethod1(Expression1,
someMethod2(longExpression2,
longExpression3));
以下是两个断开算术表达式的例子。前者更好，因为断开处位于括号表达式的外