2014开发规.docVIP

第一部分 命名 1、包（Package） 包的名字应该能够说明包的用途，通常应是名词或名词短语。包的名字应该全部由小写字母构成，例如“container”；如果包的用途必须由两个或多个单词才能描述清楚，可以直接将这些单词连接作为包名，例如“webcontainer”；如果连接后的包名太长，可以使用单词的缩写（缩写必须不会引起歧义）或取每个单词的首字母，例如“websvr”或“ws”。 2、类（Class） 类的名字应该能够说明类的用途，通常应是名词或名词短语。类的名字由若干单词连接而成，每个单词的首字母应大写，其他字母小写。例如“Server”、“WebServer”。如果某个词是一个缩写形式，则这个词应全部大写，例如“HTTPServer”、“URLBuilder”。 3、字段（field） 字段的名字应该能够说明该字段的用途，通常取名词或名词短语，也可能是形容词。字段的名字由若干单词连接构成，第一个单词应全部小写，其余单词的首字母大写，例如“color”、“backgroundColor”或“enabled”。 4、静态终态字段（static final field） 静态终态字段的名字应该能够说明该字段的用途，通常取名词或名词短语，也可能是限定性的形容词或副词。静态终态字段的名字如果只有一个单词，则该单词应全部大写，例如“NAME”、“HORIZONTAL”；静态终态字段如果由若干单词描述，则其名字应由这些单词以下划线（_）连接构成，每个单词均大写，例如“USER_NAME”、“SCROLLBARS_NEVER”。 5、局部变量（local variable） 对于作用域较大（变量的有效范围超过5行代码）的局部变量，其命名应遵循上述“字段”的命名规则；对于作用域较小（变量的有效范围不超过5行代码）的局部变量，在不至于引起混淆并且不会降低代码可读性的前提下，可以取简单的名字，例如，可以使用“i”作为小循环的循环变量名。 6、参数（parameter） 参数是指方法参数列表中的形参。参数的命名应遵循上述“字段”的命名规则。如果参数的意义与类中字段的意义相同，应尽可能使二者名字相同，例如： public void setSize(int size) { ? ? this.size = size } 7、方法（method） 所有的方法（构造函数除外）名都应能说明方法的用途，通常取动词或动词短语，也可能是名词或名词短语。方法名由若干单词连接而成，第一个单词应全部小写，其余单词的首字母大写。例如“connect”、“paintBorder”、“hashCode”。对于以名词或名词短语命名的方法，建议改成动词或动词短语形式，例如，尽量不要使用“color”这样的方法名，而是使用“getColor”。如果方法是用动词或动词短语来描述的，并且该方法是用来做判断或比较，返回一个boolean型的返回值，那么方法名中的动词应取单数第三人称形式，例如“equals”、“hasNext”。 8、集合（Collection） 对于集合或数组类型的变量，其名称应尽量取复数形式，相应的存取方法中也应使用复数形式，例如： List children; Collection getAttributes(); 另外，除了特殊情况所有命名最好不要使用中英文混合。 第二部分 代码风格 1、文件注释 每个Java源程序文件的开头都应加入该文件的javadoc注释，包含文件的作者、用途、时间、版本等信息，例如： /** * Name: SomeClass.java * Created: 2006-10-15 * Author: SomeBody */ 2、包和导入声明 文件注释之后，应留一个空行，在空行后加入包声明；包声明之后加入一个空行，空行后加入导入声明。例如： package com.somecompany.somesystem; import java.util.Collection; import javax.swing.JFrame; import com.somecompany.othersystem.*; 导入的书写次序不会影响程序的执行，但是为了提高源代码的可读性，建议将“java”开头的类首先导入，其次导入“javax”开头的类，然后倒入第三方工具包中的类，例如“org.apache.xml.*”，最后导入自己开发的其他类。 如果要导入同一包中的若干个类，在数目不超过5个的情况下，应分若干行分别导入这些类；如果数目超过5个，则应用“*”代替，只写一行导入。 3、换行和缩进 源代码中一行的长度不要超过80个字符。超出则应拆分或适当换行