java编码规范_文件组织

最近，对部门的java编码规范进行了整顿，写了本文档供大家参考，请指正。

1. 为什么要制订编码规范

好的代码风格不仅能提高可读性，而且会使代码更健壮，更为重要的是在修改时不容易出错。在现代软件开发中，维护工作会占用80%的时间，而且开发者和维护者通常不是同一个程序员。这意味着你经常要阅读和修改他人开发的程序，他人也同样可能需要阅读和修改你开发的程序。既然如此，大家何不遵守一致的JAVA编码规范，把这利人利己的事情作好呢？

2. 文件组织(File Organization)

一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过2000行的程序难以阅读，应该尽量避免。每个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联，可以将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。

2.1 开头注释(Beginning Comments)

所有的java文件在开头都应有注释，列出类名、版本信息、日期和版权声明：

/*

* Classname

*

* Version information

*

* Date

*

* Copyright notice

*/

2.2 包和引入语句(Package and Import Statements)

在多数Java源文件中，第一个非注释行是包语句。在它之后可以跟 import 语句。import中标准的包名要在本地的包名之前，而且按照字母顺序排列。如果 import 行中包含了同一个包中的不同子目录，则应该用 * 来处理。例如：

package java.awt;

import java.awt.peer.CanvasPeer;

2.3 类(Class)

首先是类的注释，一般是用来解释类的。

/**

* A class representing a set of packet and byte counters

* It is observable to allow it to be watched, but only

* reports changes when the current set is complete

*/

接下来是类定义，包含了在不同的行的 extends 和 implements

public class CounterSet extends Observable implements Cloneable{}

2.4 类的成员变量(Class Fields)

/**

* Packet counters

*/

protected int[] packets;

public 的成员变量必须生成文档(JavaDoc)。proceted、private 和 package 定义的成员变量如果名字含义明确的话，可以没有注释。

2.5 存取方法

接下来是类变量的存取的方法。它只是简单的用来将类的变量赋值获取值的话，可以简单的写在一行上，其它的方法不要写在一行上。

/**

* Get the counters

* @return an array containing the statistical data. This array has been

* freshly allocated and can be modified by the caller.

*/

public int[] getPackets() { return copyArray(packets, offset); }

public int[] getBytes() { return copyArray(bytes, offset); }

public int[] getPackets() { return packets; }

public void setPackets(int[] packets) { this.packets = packets; }

2.6 构造函数

接下来是构造函数，它应该用递增的方式写（比如：参数多的写在后面）。访问类型 ("public", "private" 等.) 和 任何 "static", "final" 或 "synchronized" 应该在一行中，并且方法和参数另写一行，这样可以使方法和参数更易读。

public CounterSet(int size){

this.size = size;

}

2.7 克隆方法

如果这个类是可以被克隆的，那么下一步就是 clone 方法：

public Object clone() {

try{

CounterSet obj = (CounterSet)super.clone();

obj.packets = (int[])packets.clone();

obj.size = size;

return obj;

}catch(CloneNotSupportedException e) {

throw new InternalError("Unexpected CloneNotSUpportedException: " + e.getMessage());

}

}

2.8 类方法

下面开始写类的方法：

/**

* Set the packet counters

* (such as when restoring from a database)

*/

protected final void setArray(int[] r1, int[] r2, int[] r3, int[] r4) throws illegalArgumentException

{

//

// Ensure the arrays are of equal size

//

if (r1.length != r2.length || r1.length != r3.length || r1.length != r4.length){

throw new IllegalArgumentException("Arrays must be of the same size");

}

System.arraycopy(r1, 0, r3, 0, r1.length);

System.arraycopy(r2, 0, r4, 0, r1.length);

}

2.9 toString 方法

无论如何，每一个类都应该定义 toString 方法：

public String toString() {

String retval = "CounterSet: ";

for (int i = 0; i < data.length(); i++) {

retval += data.bytes.toString();

retval += data.packets.toString();

}

return retval;

}

2.10 main 方法

如果main(String[]) 方法已经定义了, 那么它应该写在类的底部.