Java代码规范

一、为什么要有编码规范(Why Have Code Conventions)
编码规范对于程序员而言尤为重要，有以下几个原因：

• 一个软件的生命周期中，80%的花费在于维护 - 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护 - 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码 - 如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的 其它任何产品。为了执行规范，每个软件开发人员必须一致遵守编码规范
  二Java 源文件（.java文件）
  每个 Java 源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联，可以 将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。
  Java 源文件还遵循以下规则：
  1 开头注释，其中列出类名、版本信息、日期和版权 声明
  例如：

Paste_Image.png

2 包和引入语句
在多数 Java 源文件中，第一个非注释行是包语句。在它之后可以跟引入语句。例如：
package java.awt;
import java.awt.peer.CanvasPeer;
3 类和接口声明
下表描述了类和接口声明的各个部分以及它们出现的先后次序。

Paste_Image.png

三、排版规范
1、4 个空格常被作为缩进排版的一个单位。
2、行长度
尽量避免一行的长度超过 80 个字符，因为很多终端和工具不能很好处理。
注意：用于文档中的例子应该使用更短的行长，长度一般不超过 70 个字符。
3、 换行
当一个表达式无法容纳在一行内时，可以依据如下一般规则断开之：

• 在一个逗号后面断开
• 在一个操作符前面断开
• 宁可选择较高级别(higher-level)的断开，而非较低级别(lower-level)的断开
• 新的一行应该与上一行同一级别表达式的开头处对齐
• 如果以上规则导致你的代码混乱或者使你的代码都堆挤在右边，那就代之以缩进 8 个空格。
  以下是断开方法调用的一些例子：

Paste_Image.png

以下是两个断开算术表达式的例子。前者更好，因为断开处位于括号表达式的外边，这是个较高 级别的断开。

Paste_Image.png

以下是两个缩进方法声明的例子。前者是常规情形。后者若使用常规的缩进方式将会使第二行和 第三行移得很靠右，所以代之以缩进 8 个空格
//CONVENTIONAL INDENTATION someMethod(int anArg, Object anotherArg, String yetAnotherArg, Object andStillAnother) { ... }
//INDENT 8 SPACES TO AVOID VERY DEEP INDENTS private static synchronized horkingLongMethodName(int anArg, Object anotherArg, String yetAnotherArg, Object andStillAnother) { ... }
以下是两个缩进方法声明的例子。前者是常规情形。后者若使用常规的缩进方式将会使第二行和 第三行移得很靠右，所以代之以缩进 8 个空格

Paste_Image.png

四、语句
1、每行至多包含一条语句
int a; int b;(这样的代码最好不要出现)
2、复合语句是包含在大括号中的语句序列，形如"{ 语句 }"。例如下面各段。

• 被括其中的语句应该较之复合语句缩进一个层次
• 左大括号"{"应位于复合语句起始行的行尾；右大括号"}"应另起一行并与复合语句首行对齐。
• 大括号可以被用于所有语句，如果是单个语句，最好也是用大括号，这样便于添加语句而无需担心由于忘了加括号而引入 bug。
  3、if语句的格式：

Paste_Image.png

五、空行
1 空行，空行将逻辑相关的代码段分隔开，以提高可读性。
下列情况应该总是使用两个空行：

• 一个源文件的两个片段(section)之间 - 类声明和接口声明之间
  下列情况应该总是使用一个空行：
• 两个方法之间
• 方法内的局部变量和方法的第一条语句之间
• 一个方法内的两个逻辑段之间，用以提高可读性
  六、命名规范

Paste_Image.png

·参考文献《Java 语言编码规范》