JAVA 代碼開發規範

一.開發工具規範:

1. 開發工具經項目負責人調試後統一確定。
2. 開發工具一經確定不允許集成任何非統一插件，若有需要，經項目負責人同意後統一為 項目組成員添加。
3. 開發工具的編碼格式不允許修改。

二.排版規範:

1. 關鍵詞(或變數)和操作符之間加一個空格。 例如:int iCont = 1;//操作符和值之間有一個空格。

2. 相對獨立的代碼塊與塊之間加空行。 例如:兩個方法之間需要用空格隔開。

3. 較長的語句、表達式等要分成多行書寫。
4. 長表達式要在低優先順序操作符處劃分新行，操作符放在新行之首。
5. 代碼的新行與上一行根據邏輯關係要進行適應的縮進(一個 table 鍵)，使排版整齊，語 句易讀。
6. 不允許把多個短語句寫在一行中，即一行只寫一條語句。
7. 函數或過程的開始、結構的定義及迴圈、判斷等語句中的代碼都要採用縮進風格。採用 TABLE 鍵縮進。
8. 迴圈、判斷等語句中若有較長的表達式或語句，則要進行適應的劃分。
9. 若函數或過程中的參數較長，則要進行適當的劃分。
10. 用大括弧‘{’和‘}’界定一段程式塊時，編寫程式塊時‘{’和 ‘}’應各獨占一行 並且位於同一列，同時與引用它們的語句左對齊。在函數體的開始、類的定義、結構的定義、 枚舉的定義以及 if、for、do、while、switch、case 語句中的程式都要採用如上的縮進方 式。

JAVA代碼開發規範(WISHSOFT)

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

三.命名規範:

1. Package(包)的命名
Package 的名字應該都是由一個小寫單片語成。 例如:package com.wish;

2. Class 的命名
Class 的名字必須由大寫字母開頭而其他字母都小寫的單片語成,對於所有標識符，其

中包含的所有單詞都應緊靠在一起，而且大寫中間單詞的首字母。 例如:

public class DatabaseOperator {
}

3. Class 中成員變數的命名 變數的名字必須用一個小寫字母開頭，後面的單詞用大寫字母開頭，不需要數據類型前

綴。 例如:userName,size。

4. Class 中 Static Final 變數的命名
static Final 變數的名字應該都大寫，並且指出完整含義。
例如:
public static final String DB_CONFIG_FILE_PATH ="com.neu.etrain.dbconfig";

5. Class 中方法的命名 方法的名字開頭的單詞必須用一個小寫字母，後面的單詞用大寫字母開頭。 例如:setName() , getMethod()。

6. 方法聲明中參數命名 使用有意義的參數命名，如果可能的話，使用和要賦值的欄位一樣的名字。 例如:
public void setCounter(int size)
{

JAVA代碼開發規範(WISHSOFT)

        this.size = size;
    }

7. 方法內變數的命名
Class 中成員變數的命名。

8. 數組的命名
數組應該總是用下麵的方式來命名: byte[] buffer;而不是: byte buffer[];

9. 分頁中每頁列表數量的變數使用 pageSize，當前的所在的頁號為 pageNumber。 四.註釋規範:

1. 註釋要簡單明瞭。
2. 邊寫代碼邊註釋，修改代碼同時修改相應的註釋，以保證註釋與代碼的一致性。
3. 在必要的地方註釋，註釋量要適中。註釋的內容要清楚、明瞭，含義準確，防止註釋二 義性。保持註釋與其描述的代碼相鄰，即註釋的就近原則。
4. 變數、常量的註釋應放在其上方相鄰位置或右方，不可放在下麵。
5. 全局變數要有較詳細的註釋，包括對其功能、取值範圍、哪些函數或過程存取它以及存 取時註意事項等的說明。
6. 類，方法的註釋採用 eclipse 自動生成方法。

當把一個類，或方法的聲明寫完整後，在類，方法的正上方(不許有空格)在英文輸入 法狀態下輸入:/** 後，系統會自動生成他們的註釋模板，我們只需要填寫相應的說明文字 即可，註意:/**的下一行一定要寫功能說明。
7. 具體要求說明:

n 聲明性(變數定義類)一定要有註釋。例如:String myName; //用戶名 n 類定義必鬚生成文檔(JavaDoc)註釋。
n 方法必鬚生成文檔(JavaDoc)註釋(包括實體類的set，get方法)。 n 成員變數必鬚生成文檔(JavaDoc)註釋。

n 方法中的邏輯部分由程式編寫人根據複雜情況自行書寫。

8. 類定義的註釋信息，包括:作者;日期;模塊功能描述(如功能、主要演算法、內部各部

分之間的關係、該文件與其它文件關係等);本文件歷史修改記錄;版本信息等。

/**
* 乾什麼用的(描述信息)

JAVA代碼開發規範(WISHSOFT)

* @author lifw20080320
* @modify lifw20080321
* @modify lifw20080322 (如果有多個，依次寫多個@modify) * @copyright wishsoft
**/

9.javadoc 註釋標簽語法
@author 對類的說明 標明開發該類模塊的作者
@version 對類的說明 標明該類模塊的版本
@see 對類、屬性、方法的說明 參考轉向，也就是相關主題 @param 對方法的說明 對方法中某參數的說明
@return 對方法的說明 對方法返回值的說明
@exception 對方法的說明 對方法可能拋出的異常進行說明

五.基本數據類型首碼表(其他對象類型，隨時補充):

六.日誌組件使用規範(log4j)

1. Log 中的方法使用:
a) log.debug()是放在代碼行中間，用來調試時輸出使用，永久保留，不用刪除。
b) log.error()是放在 try{}catch(){}中 catch 部分里的用來輸出 error 異常信息使用的。