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