Java程式設計風格

一、Java檔案名稱與檔案組織圖。

    1、Java檔案名稱由實意檔案名稱+尾碼組成，尾碼名因類型的不同而不同。Java源檔案的尾碼是.java，Java位元組碼檔案的尾碼是.class。

    2、一般來說，Java源檔案的結構是，每一節代碼之間是由一個空行分割開的，並且每一節都有相應的注釋，通常情況下，Java源檔案不應該超過2000行，否則，就視為類“臃腫”。

    3、每一個Java源檔案一般由下面的順序構成。

        (1)、檔案注釋頭。

        (2)、包名(package)。

        (3)、引入(import)聲明。

        (4)、類(class)或介面(interface)的聲明部分。

二、Java檔案注釋頭。

    1、Java類檔案注釋頭是用來描述該類功能及其特點，以及相關開發資訊的。例如，如下格式：

/** * 該類功能及其特點的描述(例如：該類是用來... ...)<br/> *  * 該類未被編譯測試過<br/> *  * 開發公司或單位：能力有限公司<br/> *  * 著作權：能力有限研發中心<br/> *  * @see (與該類相關聯的類):(File.class)<br/> *  * @author : 比爾-蓋茨<br/> *  * @since ：Jdk1.6<br/> *  * @version ：v1.x-beta<br/> * * @date : 2011-11-11 11:11:11<br/> *  * 最後更改日期 ：2011-12-12 12:12:12<br/> *  * 修改人：喬布斯<br/> *  * 複審人：奧巴馬   希拉裡   克林頓<br/> * */

三、包的聲明與引用。

    1、包名應該是獨一無二不可重複的。

    2、包名通常情況下都應該是小寫ASCII字母。

    3、包名一般是公司網域名稱的倒序，經常用到的網域名稱有cn、com、edu、gov、mil、net、org。

    4、網域名稱之前的國家名稱可以由一個到兩個英文字母做首碼用來表示國家名稱，這個規則可以參考ISO標準3166。

    5、網域名稱後面的部分可以根據習慣命名。

四、Java源檔案編排格式。

    1、一般編排格式中的行間縮排，是以四個空格鍵(space)為單位的。另，一個Tab鍵是8個空格。

    2、程式碼長度。一般來說，Java的程式碼長度應該小於80個字元。

    3、折行規則。

        (1)、在逗號後折行。

        (2)、在運算子(operator)前折行。

        (3)、高層折行優於低層折行。

        (4)、折下的程式碼應與其同等級的程式碼靠左對齊。

        (5)、如果上面的法則令程式碼右側距頁邊的距離，差距較大並且混亂，我們可以在適當行採用Tab鍵處理。

五、空格與空行的應用規則。

    1、空格的應用規則。

        (1)、空格一般應用於關鍵字與括弧之間。注意：方法名稱與左括弧之間不應該用空格分開。例如：while (true) {}

        (2)、一般在參數列表中的逗號後面插入空格。例如：process(arg1, arg2, ... , argn)

        (3)、數學算式的運算元與運算子之間應該添加空格。例如：X = xx>>3; a = (a + b) / (c * d)

        (4)、for語句中的運算式應該用分號分隔開。例如：for(expr1; expr2; expr3)

        (5)、強制類型轉換語句中的強制類型的右括弧與運算式之間應該用逗號隔開。例如：(byte) num

    2、空行的應用規則。

        (1)、在同一源檔案的兩個程式碼片段之間，或者在同一源檔案的類與介面的定義之間可以插入兩行空白行。

        (2)、在如下情況中，需插入一行空白行。a).在兩個方法之間。b).在方法內部的本地變數與第一個語句之間。c).在塊注釋與單行注釋之前。d).在方法內部的邏輯片段之間。