标题：Java编码规范(from Sun)

时间：2006-5-24 来源：不详 浏览数：次

1 介绍

1.1为什么要有编码规范

编码规范对于程序员而言尤为重要，有以下几个原因：

- 一个软件的生命周期中，80%的花飞灾于维护
- 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护
- 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码
- 如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品

为了执行规范，每个软件开发人员必须一致遵守编码规范。

 

1.2版权声明

本文档反映的是Sun MicroSystems公司，Java语言规范中的编码标准部分。主要贡献者包括：Peter King，Patrick Naughton，Mike DeMoney，Jonni Kanerva，Kathy Walrath以及Scott Hommel。

本文档现由Scott Hommel维护，有关评论意见请发至shommel@eng.sun.com

 

2.文件名

这部分列出了常用的文件名及其后缀。

 

2.1文件后缀

Java程序使用下列文件后缀

文件类别

文件后缀

Java源文件

.java

Java字节码文件

.class

 

2.2常用文件名

Java程序使用下列文件后缀

文件类别

文件后缀

Java源文件

.java

Java字节码文件

.class

 

 

3.文件组织

一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过2000行的程序难以阅读，应该尽量避免。"Java源文件范例"提供了一个布局合理的Java程序范例。

 

3.1JAVA源文件

每个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联，可以将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。

Java源文件还遵循以下规则：

- 开头注释
- 包和引入语句
- 类和接口声明

 

3.1.1开头注释

所有的源文件都应该在开头有一个C语言风格的注释，其中列出类名、版本信息、日期和版权声明：

  /*

   * Classname

   *

   * Version information

   *

   * Date

   *

   * Copyright notice

   */

 

3.1.2包和引入语句

在多数Java源文件中，第一个非注释行是包语句。在它之后可以跟引入语句。例如：

  package java.awt;

 

  import java.awt.peer.CanvasPeer;

 

3.1.3类和接口说明

下表描述了类和接口声明的各个部分以及它们出现的先后次序。

 

类/接口声明的各部分

注解

1

类/接口文档注释(/**……*/)

该注释中所需包含的信息

2

类或接口的声明

 

3

类/接口实现的注释(/*……*/)如果有必要的话

该注释应包含任何有关整个类或接口的信息，而这些信息又不适合作为类/接口文档注释。

4

类的(静态)变量

首先是类的公共变量，随后是保护变量，再后是包一级别的变量(没有访问修饰符，access modifier)，最后是私有变量。

5

实例变量

首先是公共级别的，随后是保护级别的，再后是包一级别的(没有访问修饰符)，最后是私有级别的。

6

构造器

 

7

方法

这些方法应该按功能，而非作用域或访问权限，分组。例如，一个私有的类方法可以置于两个公有的实例方法之间。其目的是为了更便于阅读和理解代码。

 

 

4.缩进排版

4个空格常被作为缩进排版的一个单位。缩进的确切解释并未详细指定(空格 vs. 制表符)。一个制表符等于8个空格(而非4个)。

 

4.1行长度

尽量避免一行的长度超过80个字符，因为很多终端和工具不能很好处理之。

注意：用于文档中的例子应该使用更短的行长，长度一般不超过70个字符。

 
（责任编辑：欣欣裴）