Package 的命名 Package 的名字应该都是由一个小写单词组成。 Class 的命名 Class 的名字必须由大写字母开头而其他字母都小写的单词组成 Class 变量的命名 变量的名字必须用一个小写字母开头。后面的单词用大写字母开头。 Static Final 变量的命名 Static Final 变量的名字应该都大写,并且指出完整含义。 参数的命名 参数的名字必须和变量的命名规范一致。 数组的命名 数组应该总是用下面的方式来命名:
byte[] buffer;
而不是:
byte buffer[];
方法的参数 使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字:
SetCounter(int size){ this.size = size; }
Java 文件样式 所有的 Java(*.java) 文件都必须遵守如下的样式规则
版权信息 版权信息必须在 java 文件的开头,比如:
/** * Copyright ? 2000 Shanghai XXX Co. Ltd. * All right reserved. */
/** * 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
Class Fields 接下来是类的成员变量:
/** * Packet counters */ protected int[] packets;
public 的成员变量必须生成文档(JavaDoc)。proceted、private和 package 定义 的成员变量如果名字含义明 确的话,可以没有注释。
/** * 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; }
/** * 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); }
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; } }
class Colour { public static final Colour BLACK = new Colour(0, 0, 0); public static final Colour RED = new Colour(0xFF, 0, 0); public static final Colour GREEN = new Colour(0, 0xFF, 0); public static final Colour BLUE = new Colour(0, 0, 0xFF); public static final Colour WHITE = new Colour(0xFF, 0xFF, 0xFF); }
这种技术实现了RED, GREEN, BLUE 等可以象其他语言的枚举类型一样使用的常量。 他们可以用 '==' 操作符来 比较。 但是这样使用有一个缺陷:如果一个用户用这样的方法来创建颜色 BLACK