Java 语言编码规范(Java Code Conventions)

如需复制、传播，请附上本声明，谢谢。
原文出处：http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html，
译文出处：http://morningspace.51.net/，moyingzz@etang.com
目录
1 介绍
• 1.1 为什么要有编码规范
• 1.2 版权声明
2 文件名
• 2.1 文件后缀
• 2.2 常用文件名
3 文件组织
• 3.1 Java源文件
o 3.1.1 开头注释
o 3.1.2 包和引入语句
o 3.1.3 类和接口声明
4 缩进排版
• 4.1 行长度
• 4.2 换行
5 注释
• 5.1 实现注释的格式
o 5.1.1 块注释
o 5.1.2 单行注释
o 5.1.3 尾端注释
o 5.1.4 行末注释
• 5.2 文挡注释
6 声明
• 6.1 每行声明变量的数量
• 6.2 初始化
• 6.3 布局
• 6.4 类和接口的声明
7 语句
• 7.1 简单语句
• 7.2 复合语句
• 7.3 返回语句
• 7.4 if，if-else，if else-if else语句
• 7.5 for语句
• 7.6 while语句
• 7.7 do-while语句
• 7.8 switch语句
• 7.9 try-catch语句
8 空白
• 8.1 空行
• 8.2 空格
9 命名规范
10 编程惯例
• 10.1 提供对实例以及类变量的访问控制
• 10.2 引用类变量和类方法
• 10.3 常量
• 10.4 变量赋值
• 10.5 其它惯例
o 10.5.1 圆括号
o 10.5.2 返回值
o 10.5.3 条件运算符"?"前的表达式"?"前的表达式
o 10.5.4 特殊注释
11 代码范例
• 11.1 Java源文件范例
1 介绍(Introduction)
1.1 为什么要有编码规范(Why Have Code Conventions)
编码规范对于程序员而言尤为重要，有以下几个原因：
- 一个软件的生命周期中，80%的花费在于维护
- 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护
- 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码
- 如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的
其它任何产品
为了执行规范，每个软件开发人员必须一致遵守编码规范。每个人。
1.2 版权声明(Acknowledgments)
本文档反映的是Sun MicroSystems 公司，Java 语言规范中的编码标准部分。主要贡献者包
括：Peter King，Patrick Naughton，Mike DeMoney，Jonni Kanerva，Kathy Walrath
以及Scott Hommel。
本文档现由Scott Hommel 维护，有关评论意见请发至shommel@eng.sun.com
2 文件名(File Names)
这部分列出了常用的文件名及其后缀。
2.1 文件后缀(File Suffixes)
Java 程序使用下列文件后缀：
文件类别文件后缀
Java 源文件.java
Java 字节码文件.class
2.2 常用文件名(Common File Names)
常用的文件名包括：
文件名用途
GNUmakefile makefiles 的首选文件名。我们采用gnumake 来创建（build）软件。
README 概述特定目录下所含内容的文件的首选文件名
3 文件组织(File Organization)
一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过2000 行的程
序难以阅读，应该尽量避免。"Java 源文件范例"提供了一个布局合理的Java 程序范例。
3.1 Java 源文件(Java Source Files)
每个Java 源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联，可以
将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。
Java 源文件还遵循以下规则：
- 开头注释（参见"开头注释"）
- 包和引入语句（参见"包和引入语句"）
- 类和接口声明（参见"类和接口声明"）
3.1.1 开头注释(Beginning Comments)
所有的源文件都应该在开头有一个C 语言风格的注释，其中列出类名、版本信息、日期和版权
声明：
/*
* Classname
*
* Version information
*
* Date
*
* Copyright notice
*/
3.1.2 包和引入语句(Package and Import Statements)
在多数Java 源文件中，第一个非注释行是包语句。在它之后可以跟引入语句。例如：
package java.awt;
import java.awt.peer.CanvasPeer;
3.1.3 类和接口声明(Class and Interface Declarations)
下表描述了类和接口声明的各个部分以及它们出现的先后次序。参见"Java源文件范例"中一个
包含注释的例子。
类/接口声明的各部分注解
1
类/接口文档注释
(/**……*/)
该注释中所需包含的信息，参见"文档注释"
2 类或接口的声明
3 类/接口实现的注释该注释应包含任何有关整个类或接口的信息，而这些信息又不适合
(/*……*/)如果有必要的
话
作为类/接口文档注释。
4 类的(静态)变量
首先是类的公共变量，随后是保护变量，再后是包一级别的变量(没
有访问修饰符，access modifier)，最后是私有变量。
5 实例变量
首先是公共级别的，随后是保护级别的，再后是包一级别的(没有访
问修饰符)，最后是私有级别的。
6 构造器
7 方法
这些方法应该按功能，而非作用域或访问权限，分组。例如，一个
私有的类方法可以置于两个公有的实例方法之间。其目的是为了更
便于阅读和理解代码。
4 缩进排版(Indentation)
4 个空格常被作为缩进排版的一个单位。缩进的确切解释并未详细指定(空格vs. 制表符)。一
个制表符等于8 个空格(而非4 个)。
4.1 行长度(Line Length)
尽量避免一行的长度超过80 个字符，因为很多终端和工具不能很好处理之。
注意：用于文档中的例子应该使用更短的行长，长度一般不超过70 个字符。
4.2 换行(Wrapping Lines)
当一个表达式无法容纳在一行内时，可以依据如下一般规则断开之：
- 在一个逗号后面断开
- 在一个操作符前面断开
- 宁可选择较高级别(higher-level)的断开，而非较低级别(lower-level)的断开
- 新的一行应该与上一行同一级别表达式的开头处对齐
- 如果以上规则