java编码规范手册.docxVIP

Java编码规范 1、包（Package） 包的名字应该能够说明包的用途，通常应是名词或名词短语。 ①包的名字应该全部由小写字母构成，例如“container”； ②如果包的用途必须由两个或多个单词才能描述清楚，可以直接将这些单词连接作为包名，例如“webcontainer”； ③如果连接后的包名太长，可以使用单词的缩写（缩写必须不会引起歧义）或取每个单词的首字母，例如“websvr”或“ws”。 2、类（Class） 类的名字应该能够说明类的用途，通常应是名词或名词短语。 ①类的名字由若干单词连接而成，每个单词的首字母应大写，其他字母小写。例如“Server”、“WebServer”。 ②如果某个词是一个缩写形式，则这个词应全部大写，例如“HTTPServer”、“URLBuilder”。 ③如果该类为测试类，应该在类名后带上”Test”，如LoginTest ④如果该类为异常类，应该在类名后带上”Exception”，如LoginException ⑤定义struts的Action，如角色Action：RoleAction 3、字段(或属性)（field） 字段的名字应该能够说明该字段的用途，通常取名词或名词短语，也可能是形容词。 字段的名字由若干单词连接构成，第一个单词应全部小写，其余单词的首字母大写，例如“color”、“backgroundColor”或“enabled”。 4、静态终态字段(或属性)（static final field） 静态终态字段的名字应该能够说明该字段的用途，通常取名词或名词短语，也可能是限定性的形容词或副词。 ①静态终态字段的名字如果只有一个单词，则该单词应全部大写，例如“NAME”、“HORIZONTAL”； ②静态终态字段如果由若干单词描述，则其名字应由这些单词以下划线（_）连接构成，每个单词均大写，例如“USER_NAME”、“SCROLLBARS_NEVER”。 ③例外，日志写法： private static final Log log = LogFactory.getLog(AccountAction.class); 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”。 Java 注释约定 　　2.1. 一般概念 　* 注释应该增加代码的清晰度 　　* 保持注释的简洁 　　* 在写代码之前写注释 　　* 注释出为什么做了一些事，而不仅仅是做了什么 ??? 2.2. 示范 　　* 文档注释 ???? 在紧靠接口、类、成员函数和字段声明的前面注释它们。 ???? /** ??? * 客户：客户是我们将服务和产品卖给的人或机构。 ???? */ C 语言风格 ????? 采用 C 语言风格的注释去掉不再使用但你仍想保留的代码。仍想保留是因为用户万一会改变想法，或者在调试过程中想让它暂时失效。如： /* 这部分代码因为已被它之前的代码取代，由 B.Gustafsson, 于 1999 年 6 月?? ??? *4 日注释掉。如果两年之后还未使用，将其删除。. . . ??? *（源代码） ??? */ 单行 ????? 在成员函数内采用单行注释，来说明业务逻辑、代码段和暂时变量的声明。注释符//后必须紧跟一个空格，然后才是注释信息。 如： ???? // 遵照 Sarek