Java编程风格规范讲述.doc

Java编程风格规范 目录 目录 1 一、 前言 3 1 术语说明 3 2 规范说明 3 二、 源文件基础 4 1 文件名 4 2 文件编码：UTF-8 4 3 特殊字符 4 三、 源文件结构 6 1 许可证或版本信息 6 2 package语句 6 3 import语句 6 4 类声明 7 四、 格式 8 1 大括号 8 2 块缩进：4个空格 10 3 一行一个语句 10 4 列限制：160字符 10 5 自动换行 11 6 空白 12 7 用小括号来限定组：推荐 14 8 具体结构 15 五、 命名约定 19 1 对所有标识符都通用的规则 19 2 标识符类型的规则 19 3 驼峰式命名法(CamelCase) 21 六、 编程实践 23 1 @Override：能用则用 23 2 捕获的异常：不能忽视 23 3 静态成员：使用类经行调用 23 4 Finalizers：禁用 24 5 源文件和方法：代码行数限制 24 6 其它：建议 24 七、 Javadoc 25 1 格式 25 2 摘要片段 25 3 哪里需要使用Javadoc 26 八、 参考 27 一．前言 这份文档是Java编程风格规范的完整定义。当且仅当一个Java源文件符合此文档中的规则， 我们才认为它符合Java编程风格。与其它的编程风格规范一样，这里所讨论的不仅仅是编码格式美不美观的问题， 同时也讨论一些约定及编码标准。然而，这份文档主要侧重于我们所普遍遵循的规则， 对于那些不是明确强制要求的，我们尽量避免提供意见。 1.1 术语说明 在本文档中，除非另有说明： 1.术语class可表示一个普通类，枚举类，接口或是annotation类型(@interface) 2.术语comment只用来指代实现的注释(implementation comments)，我们不使用“documentation comments”一词，而是用Javadoc。 其他的术语说明会偶尔在后面的文档出现。 本文档中的示例代码遵编程风格，但并不意味着这是展现这些代码的唯一方式。源文件结构 3.1 许可证或版权信息 如果一个文件包含许可证或版权信息，那么它应当被放在文件最前面。 3.2 package语句 package语句不换行，列限制(4.4节)并不适用于package语句。(即package语句写在一行里) 3.3 import语句 3.3.1 import不要使用通配符 即，不要出现类似这样的import语句：import java.util.*; 3.3.2 不要换行 import语句不换行，列限制(4.4节)并不适用于import语句。(每个import语句独立成行) 3.3.3 顺序和间距 import语句可分为以下几组，按照这个顺序，每组由一个空行分隔： 1.所有的静态导入独立成组 (不建议使用静态导入) 2.java imports 3.javax imports 4.第三方的包。每个顶级包为一组，字典序。例如：com, junit, org, sun 组内不空行，按字典序排列。 3.4 类声明 3.4.1 只有一个顶级类声明 每个顶级类都在一个与它同名的源文件中(当然，还包含.java后缀)。 类声明(static)根据public，protected，default(即包访问级别，没有修饰符，为了可读性这里写成default)，private依次排序 3.4.2 类成员顺序 类的成员顺序对易学性有很大的影响，但这也不存在唯一的通用法则。不同的类对成员的排序可能是不同的。最重要的一点，每个类应该以某种逻辑去排序它的成员，维护者应该要能解释这种排序逻辑。比如，新的方法不能总是习惯性地添加到类的结尾，因为这样就是按时间顺序而非某种逻辑来排序的。类的成员必须写在构造方法和方法的前面，即紧接着类定义的后面。 建议：按有static,final,volatile,transient等关键字的依次排序，同时根据成员的可见性public，protected，default(即包访问级别，没有修饰符，为了可读性这里写成default)，private依次排序，这样一来可以综合多种排序因素，而实际排序方式根据实际情况而定。 重载：永不分离 当一个类有多个构造方法，或是多个同名方法，这些方法应该按顺序出现在一起，中间不要放进其它方法。 四．格式 术语说明：块状结构(block-like construct)指的是一个类，方法或构造方法的主体。需要注意的是，数组初始化中的初始值可被选择性地视为块状结构(节)。 4.1 大括号 4.1.1 使用大括号(即使是可选的) 大括号与if, else, for, do, while语句一起使用，即使