JAVA命名規範

　　關於Java中各種元素的命名，定義這些規範的目的是讓項目中所有的文檔都看起來像一個人寫的，增加可讀性，減少項目組中因為換人而帶來的損失。(這些規範並不是一定要絕對遵守，但是一定要讓程式有良好的可讀性)：

1. Package 的命名
   Package 的名字應該都是由一個小寫單片語成。

2. Class 的命名
   Class 的名字必須由大寫字母開頭而其他字母都小寫的單片語成。

3. Class 變數的命名
   變數的名字必須用一個小寫字母開頭。後面的單詞用大寫字母開頭。

4. Static Final 變數的命名
   Static Final 變數的名字應該都大寫，並且指出完整含義。

5. 參數的命名
   參數的名字必須和變數的命名規範一致。

6. 數組的命名
   數組應該總是用下麵的方式來命名:
   

   1 　　byte[] buffer; 

   而不是:
   

   1 　　byte buffer[];

7. 方法的參數
   使用有意義的參數命名，如果可能的話，使用和要賦值的欄位一樣的名字:
   

   1 　　SetCounter(int size){
   2 　　this.size = size;
   3 　　}

8. Java 文件樣式
   所有的 Java(*.java) 文件都必須遵守如下的樣式規則 。
   　　版權信息必須在 java 文件的開頭，比如:
   

   1 　　/**
   2 　　* Copyright ?0?3 2000 Shanghai XXX Co. Ltd.
   3 　　* All right reserved.
   4 　　*/ 

   　　其他不需要出現在 javadoc 的信息也可以包含在這裡。
9. Package/Imports
   package 行要在 import 行之前，import 中標準的包名要在本地的包名之前，而且按照字母順序排列。
   如果 import 行中包含了同一個包中的不同子目錄，則應該用 * 來處理。
   

   1 　　package hotlava.net.stats;
   2 　　import java.io.*;
   3 　　import java.util.Observable;
   4 　　import hotlava.util.Application; 

   這裡 java.io.* 使用來代替InputStream and OutputStream 的。
10. Class
    接下來的是類的註釋，一般是用來解釋類的。
    

    1 　　/**
    2 　　* A class representing a set of packet and byte counters
    3 　　* It is observable to allow it to be watched, but only
    4 　　* reports changes when the current set is complete
    5 　　*/

    接下來是類定義，包含了在不同的行的 extends 和 implements
    

    1 　　public class CounterSet
    2 　　extends Observable
    3 　　implements Cloneable
    4 　　Class Fields 

    接下來是類的成員變數:
    

    1 　　/**
    2 　　* Packet counters
    3 　　*/
    4 　　protected int[] packets; 

    public 的成員變數必鬚生成文檔(JavaDoc)。proceted、private和 package 定義的成員變數如果名字含義明確的話，可以沒有註釋。
11. 存取方法
    接下來是類變數的存取的方法。它只是簡單的用來將類的變數賦值獲取值的話，可以簡單的寫在一行上。
    

    1 　　/**
    2 　　* Get the counters
    3 　　* @return an array containing the statistical data. This array has been
    4 　　* freshly allocated and can be modified by the caller.
    5 　　*/
    6 　　public int[] getPackets() { return copyArray(packets, offset); }
    7 　　public int[] getBytes() { return copyArray(bytes, offset); }
    8 　　public int[] getPackets() { return packets; }
    9 　　public void setPackets(int[] packets) { this.packets = packets; } 

    其它的方法不要寫在一行上
12. 構造函數
    接下來是構造函數，它應該用遞增的方式寫(比如:參數多的寫在後面)。
    訪問類型 (“public”, “private” 等.) 和 任何 “static”, “final” 或 “synchronized” 應該在一行中，並且方法和參數另寫一行，這樣可以使方法和參數更易讀。
    

    1 　　public
    2 　　CounterSet(int size){
    3 　　this.size = size;
    4 　　}

13. 克隆方法
    如果這個類是可以被克隆的，那麼下一步就是 clone 方法:
    

     1 　　public
     2 　　Object clone() {
     3 　　try {
     4 　　CounterSet obj = (CounterSet)super.clone();
     5 　　obj.packets = (int[])packets.clone();
     6 　　obj.size = size;
     7 　　return obj;
     8 　　}catch(CloneNotSupportedException e) {
     9 　　throw new InternalError(“Unexpected CloneNotSUpportedException: ” + e.getMessage());
    10 　　}
    11 　　}

14. 類方法
    下麵開始寫類的方法:
    

     1 　　/**
     2 　　* Set the packet counters
     3 　　* (such as when restoring from a database)
     4 　　*/
     5 　　protected final
     6 　　void setArray(int[] r1, int[] r2, int[] r3, int[] r4)
     7 　　throws IllegalArgumentException
     8 　　{
     9 　　// Ensure the arrays www.gzlij.com are of equal size
    10 if (r1.length != r2.length || r1.length != r3.length || r1.length != r4.length)
    11 　　throw new IllegalArgumentException(“Arrays must be of the same size”);
    12 　　System.arraycopy(r1, 0, r3, 0, r1.length);
    13 　　System.arraycopy(r2, 0, r4, 0, r1.length);
    14 　　}

15. toString 方法
    無論如何，每一個類都應該定義 toString 方法:
    

     1 　　public
     2 　　String toString() {
     3 　　String retval = “CounterSet: “;
     4 　　for (int i = 0; i < data.length(); i++) {
     5 　　retval += data.bytes.toString();
     6 　　retval += data.packets.toString();
     7 　　}
     8 　　return retval;
     9 　　}
    10 　　}

16. main 方法
    如果main(String[]) 方法已經定義了, 那麼它應該寫在類的底部.