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 對辦法的闡明 對辦法能夠拋出的異常停止闡明

五.根本數據類型前綴表(其他對象類型，隨時補充):

Java 中數據類型

數據類型前綴

int

i

String

str

char

c

long

l

float

f

double

d

boolean

b

short

s

byte

byte

vector

v

六.日志組件運用標准(log4j)

1. Log 中的辦法運用:
a) log.debug()是放在代碼行兩頭，用來調試時輸入運用，永世保存，不必刪除。
b) log.error()是放在 try{}catch(){}中 catch 局部裡的用來輸入 error 異常信息運用的。