JAVA编码规范

文件命名
Java的文件主要有两种，编程的源代码与解释后的字节码，前者的后缀是.java，后者是.class。Java的文件名是大小写敏感的。

起始注释
所有的源代码文件都应该有C语言风格的起始注释，列出类名、版本号、日期和版权信息等，如下所示：
/***************************************************************
*文件名称：*.java
*版本：
*日期：
*作者：
*说明：
*类说明：
*其他说明：
**************************************************************/

包和引用声明
大部分Java源代码文件的非注释内容的第一行是包声明（如果有的话），然后是引用声明。需要注意的是，包的名字全部采用小写。

类和接口声明(Class and Interface Declarations)
下表描述了类和接口声明的各个部分以及它们出现的先后次序。
1.类/接口文档注释(/**……*/)
该注释中所需包含的信息，参见"文档注释"
2.类或接口的声明
3.类/接口实现的注释(/*……*/)
如果有必要的话，该注释应包含任何有关整个类或接口的信息，而这些信息又不适合作为类/接口文档注释。
4.类的(静态)变量
首先是类的公共变量，随后是保护变量，再后是包一级别的变量(没有访问修饰符，access modifier)，最后是私有变量。
5.实例变量
首先是公共级别的，随后是保护级别的，再后是包一级别的(没有访问修饰符)，最后是私有级别的。
6.构造器
7.方法
这些方法应该按功能，而非作用域或访问权限，分组。例如，一个私有的类方法可以置于两个公有的实例方法之间。其目的是为了更便于阅读和理解代码。

缩进排版：4个空格常被作为缩进排版的一个单位。缩进的确切解释并未详细指定(空格 vs. 制表符)。一个制表符等于8个空格(而非4个)。

行长度
尽量避免一行的长度超过80个字符，因为很多终端和工具不能很好处理之。
注意：用于文档中的例子应该使用更短的行长，长度一般不超过70个字符。

注释
实现注释用以注释代码或者实现细节。文档注释从实现自由(implementation-free)的角度描述代码的规范。它可以被那些手头没有源码的开发人员读懂。
注释应被用来给出代码的总括，并提供代码自身没有提供的附加信息。注释应该仅包含与阅读和理解程序有关的信息。例如，相应的包如何被建立或位于哪个目录下之类的信息不应包括在注释中。
在注释里，对设计决策中重要的或者不是显而易见的地方进行说明是可以的，但应避免提供代码中己清晰表达出来的重复信息。多余的注释很容易过时。通常应避免那些代码更新就可能过时的注释。
注意：频繁的注释有时反映出代码的低质量。当你觉得被迫要加注释的时候，考虑一下重写代码使其更清晰。
注释不应写在用星号或其他字符画出来的大框里。注释不应包括诸如制表符和回退符之类的特殊字符。
块注释通常用于提供对文件，方法，数据结构和算法的描述。块注释被置于每个文件的开始处以及每个方法之前。它们也可以被用于其他地方，比如方法内部。在功能和方法内部的块注释应该和它们所描述的代码具有一样的缩进格式。

命名规范包(Packages) ：包名的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门(department)，项目(project)，机器(machine)，或注册名(login names)。
类(Classes)：类名是个一名词，采用大小写混合的方式，每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词，避免缩写词(除非该缩写词被更广泛使用，像URL，HTML)。
接口(Interfaces)：命名规则：大小写规则与类名相似。
方法(Methods)：方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。
变量(Variables)：除了变量名外，所有实例，包括类，类常量，均采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。变量名不应以下划线或美元符号开头，尽管这在语法上是允许的。变量名应简短且富于描述。变量名的选用应该易于记忆，即，能够指出其用途。尽量避免单个字符的变量名，除非是一次性的临时变量。临时变量通常被取名为i，j，k，m和n，它们一般用于整型；c，d，e，它们一般用于字符型。
实例变量(Instance Variables)：大小写规则和变量名相似，除了前面需要一个下划线。
常量(Constants)：类常量和ANSI常量的声明，应该全部大写，单词间用下划线隔开。(尽量避免ANSI常量，容易引起错误)