編碼規範

用全英文單詞命名的方式，準確地描述變量、屬性、類等。如：使用firstName, grandTotal等命名就比x1,y1,fn等更容易讓人理解其含義，儘管它們的長度要大一些。
採用一些更加準確的術語來命名。例如，若是咱們的用戶稱他們的clients爲customers，那麼咱們就應該採用customer來命名，而不是採用client來命名。這是一些細微的地方，但也但願能注意。
採用大小寫混合的方式來命名，以便命名有很好的可讀性。在JAVA代碼中，將採用以下原則：類或接口命名中每一個單詞的首字母均大寫，其它單詞的首字母均大寫。其它像變量、成員方法、屬性等除第一個單詞所有小寫之外，其它單詞的首字母均大寫，而單詞的剩餘部分均小寫。????
儘可能少用單詞的縮寫形式，但若是必定要用，則必需要選擇你們通用的縮寫方式，而且要在本JAVA源代碼中堅持用它，而不要一會用這種縮寫方式，一會用那種縮寫方式。好比，若是要用"number"的縮寫方式，則可用"no"或"num"兩種縮寫方式，而不要用"nu"這種你們不經常使用的縮寫方式，而且要保持不變。
儘可能避免太長的命名，通常以少於20個字符爲宜。
儘可能避免使用這樣的命名：兩個或多個命名僅僅是其中的有些字符大小寫不同，或者僅僅是其中有些單詞是單複數之區別。例如：persistentObject 與 persistentObjects; anSqlDatabase 與 anSQLDatabase等。
儘可能避免使用下劃線，如要特殊須要可使用。

代碼註釋的通常原則和類型

在JAVA代碼中，咱們常常要使用代碼註釋的方式來幫助理解代碼的含義。代碼註釋的通常原則主要有如下幾個方面：

代碼中的註釋應該以讓人一目瞭然爲目標。咱們之因此要增長代碼註釋，其目的就是爲了讓編寫代碼的人、同一項目組的成員或之後的開發人員能很容易的理解其代碼的意圖。
避免使用標語式的、實際毫無用處的代碼註釋。
儘可能採用簡潔、易懂的註釋代碼，而不要長篇大論。
有些特殊的代碼中要加以適當的註釋，以說明其爲何要這樣作。例如，一些特殊的商業規範的計算等等。

在JAVA代碼中，常用三種類型的註釋：文檔型的註釋，其通常格式是：以"/**"開頭，以"*/"結尾； C語言類型的註釋，它一般是以"/*"開頭，以"*/"結尾；還有一種是一般用的單行註釋的方法，即以"//"開頭，對一個單行進行註釋。下面以表格的方式，分別說明這三種方式在JAVA中如何更好的使用。

註釋類型	使用方式	例程
文檔型註釋	文檔型註釋常常用在定義接口，類，成員方法，域的定義以前，而且這種註釋能夠被經過javadoc直接生成幫助文檔。	/** Customer- A customer is any person or …… @author S.W.Ambler */ public class Customer{}
C風格型的註釋	當要一次對多行代碼進行註釋，或者這些代碼將不被執行，或者對這些行進行調試時，本註釋是一種比較合適的註釋方法。	/* This code was commented .. ………… ……(the source code) */
單行註釋	一般在成員方法內部註釋商業邏輯，一小節代碼，或者臨時變量的聲明。	//Apply a 5% discount to all //invoices over $1000 as //defined by the …..

同時，爲了編程人員所作的文檔型註釋，能更有效的生成HTML格式的幫助文件，將提供如下一些更多的內容：

標誌	使用	目的
@author authorName	通常在類、接口定義以前的文檔型註釋裏面使用。	通常是指明編寫本接口或本類的做者，固然能夠有多個，每個做者用@author標明。
@deprecated	通常在類，成員方法定義以前的文檔型註釋裏面使用。	它通常用於聲明一個類或者一個成員方法被廢棄，再也不使用。
@exception name description	成員方法定義以前的文檔型註釋裏面使用。	用於聲明本成員方法將可能會拋出的異常。每個異經常使用一個@exception標明。
@param name description	成員方法定義以前的文檔型註釋裏面使用。	用於說明傳遞給該成員方法的參數，包括其類型和它的使用，每個參數用@param標明。
@return description	成員方法定義以前的文檔型註釋裏面使用。	用於說明本成員方法的返回值類型，若是可能，適當的描述其可能的返回值
@see ClassName	通常在類，接口，成員方法，域定義以前的文檔型註釋裏面使用。	用於創建一個超文本連接到指定的類，接口。通常應該詳細的描述其類名。
@see ClassName#member functionsName	通常在類，接口，成員方法，域定義以前的文檔型註釋裏面使用。	用於創建一個超文本連接到指定的成員方法。通常應詳細描述類名。
@version text	通常在類，接口定義以前的文檔型註釋裏使用。	用於指定相應的版本信息。

方法命名和註釋規範
1. 成員方法的命名

成員方法的命名應該採用全英文單詞且是大小寫混合的方式來進行。方法名的第一個單詞均小寫，其它單詞的首字母大寫。並且方法名中第一個單詞最好是一個動詞形式的。如：openAccount() , printMailingLabel() , save() , delete() 等。

經過這樣的命名規範，很容易看出這個方法是幹什麼用的，它的目的是什麼。儘管有時方法名會比較長，但它能很容易讓其餘人理解本方法的意圖。

get方法，它通常返回一個屬性值，通常應將get放在方法名中第一個單詞的位置。而當它返回的是判斷其結果是true或者false的時候，通常用"is"來取代"get"。例如：getFirstName() , getAccountNumber() , isPersistent() , isAtEnd() 等等。

經過這種命名規範，就能夠很清楚的知道本方法是返回一個對象的屬性或返回一個boolean值。

一樣，對於set方法，它通常是用於設置對象的屬性值，一樣也將set放在方法名中的第一個單詞的位置。如：setFirstName(String aName), setAtEnd(boolean isAtEnd), setPersistent(boolean isPersistent)等等。

構造方法的命名

構造方法通常是用來建立一個對象時要執行的初始化操做。構造方法必須具備與類名徹底一致的名字，其大小寫也必須徹底一致。這種命名規範是由sun公司肯定，且必須遵照。

成員方法的頭部註釋文檔規範

每個成員方法的前面必需要有相應的註釋文檔說明，它主要包括如下內容，但不只限於如下內容：

本成員方法的目的是什麼。
本成員方法要傳遞的參數是什麼。它們是如何被使用的。
本成員方法的返回值是什麼。
本成員方法會拋出什麼樣的異常。
代碼更改的一些歷史信息，如何時被更改過，誰更改的，目的是什麼等等一些信息。

成員方法的內部註釋文檔規範

爲了更好的描述成員方法的目的，還會在成員方法的內部給予適當的註釋，通常有兩種格式：/*……..*/和//……….。通常而言，內部註釋文檔應該說明如下一些要素：

控制結構，描述每個控制結構是什麼樣的。
在某些特殊的地方說明本代碼爲何要這樣編寫。例如，在某些特殊的商業規範的處理代碼中，給予說明。
局部變量的說明，一般用單行的註釋說明它們是如何使用的，意義是什麼。
對難以理解的，複雜的代碼要有適當的說明，以便於其餘開發人員理解。
對一些必須按照特定的順序被執行，不然出錯的代碼段，對其處理順序進行適當的文檔說明。

成員方法的訪問權限控制

成員方法的訪問權限控制的基本原則是儘可能的限制對成員方法的訪問權限。若是沒有必要設置爲public，則將其設置爲protected，不然設置爲默認方式或者private。

getXxxx方法和setXxxx方法的使用

getXxxx方法和setXxxx方法的名稱通常是： get + 屬性名/ set + 屬性名或 is +屬性名。例如：

屬性名	類型	get方法	set方法
FirstName	String	getFirstName()	setFirstName(參數表)
Persistent	Boolean	isPersistent()	setPersistent(參數表)
OrderItems	Array of OrderItems Objects	getOrderItems()	setOrderItems(參數表)

getXxxx方法和setXxxx方法通常對其有以下的使用方式：

設置對象屬性的初始值；
更新對象的屬性值；
獲得屬性值；
控制對屬性值的訪問和修改，特別是修改；
訪問常量；
訪問數組，vector等多值數據變量；
下降父、子類之間的耦合程度。例如：

// Answer the branch number, which is the leftmost four digits of the full account number

protected int getBranchNumber(){

if (branchNumber = = 0){

//The default branch number is 1000,which is the main branch in downtown Bedrock

setBranchNumber(1000);

}

return branchNumber;

}

getXxxx方法和setXxxx方法的訪問權限的控制：

通常狀況，將它們設置爲"protected"，這樣，只有同包類或子類的對象能夠訪問它們。可是一般將getXxxx方法設置爲"public"方式，而setXxxx方法則是"protected"方式。只有在極少數狀況下才將setXxxx方法設置爲"public"方式。固然，有時也將setXxxx方法設置爲"private"方式。

屬性變量的命名和註釋規範
1. 屬性變量的命名規範

屬性變量的命名採用全英文單詞的混合命名方式，第一個單詞所有小寫，之後單詞的

第一個字母大寫，其他小寫。以便讓它易於理解。而對於那些像數組或動態數組等一些多值的數據類型屬性，則應該採用單詞複數的方式命名（s加在最後一個單詞上面），它的主要優勢是能夠方便的指明它們有多個值。例如： firstName, zipCode, orderItems等。

屬性變量的訪問權限控制

爲了使對象具備更好的封閉性，通常不把屬性的訪問權限設置爲public，建議通常把全部的屬性訪問權限設置爲private，以防止其它類的對象直接訪問本類對象的屬性。而對屬性的訪問能夠用getXxxx方法和setXxxx方法進行。

屬性變量的註釋

每個屬性變量都要給予註釋，以便其餘開發人員更好的理解其含義。通常從如下幾個方面給予註釋：

描述屬性變量，以便其餘開發人員知道如何使用它；
訪問權限的說明。若是你的屬性變量的訪問權限不是private修飾的，則必須給予說明其爲何是這樣的；
對於某些特殊取值（範圍）的屬性，其取值（範圍）給予適當的說明，以便其餘開發人員理解和使用；
適當的例子說明。對與某些特殊狀況相關的屬性，可適當的加以例子說明，以便於別人更好的理解和使用。

組件變量的命名規範

對於組件的命名，通常採用全英文單詞的命名方式，可是採用將組件類型名做爲後綴的方法。這樣，就很容易識別這個組件變量的目的，從它的後綴類型就能夠方便的看出。也很容易在列表中找到每個組件（在不少可視化編程環境中，提供列表的方式來快速顯示全部用到的組件變量）。如： okJButton, fileJMenu, newFileMenuItem等等。

常量命名規範

常量命名採用全英文單詞的方式進行，且全是大寫的字母，單詞之間用下劃線鏈接。如：MINIMUM_BALANCE, DEFAULT_START_DATE等等。它的主要優勢是能夠很容易的與變量區分開來。

局部變量的命名和註釋規範

通常而言，局部變量的命名規範遵循屬性變量的命名規範，即全用英文單詞命名，且除第一個單詞之外，其它單詞的首字母均大寫。

可是，對於下面所列舉的幾種特殊類型的局部變量的命名有些特殊的規定：

1．streams

當一個單一的輸入或輸出流對象被定義和使用時，通常用in,inputStream表示輸入流，而用out,outputStream表示輸出流。而當一個流同時被使用爲輸入流和輸出流的時候，則用inOut或者ioStream來命名。

2．循環計數器的使用

因爲在成員方法中，咱們常常會用一些循環結構，同時也就會使用循環計數器。在之前的C，C++中，已經習慣於使用像i,j,k等變量做爲循環計數器，在JAVA編碼中，也採用經常使用的，單一的小寫字母來命名循環計數器。例如：for(i=0;i<10;i++)

3．異常對象的命名規範

在JAVA中，常常會碰到一些例外狀況的處理，通常用一個字母"e"來命名相應的例外對象，如存在多個異常則採用屬性的命名方式。

局部變量的文檔註釋通常涉及到如下幾個方面：

說明局部變量是如何被使用的；
局部變量的聲明與使用盡可能靠近，也即等到要使用的時候才聲明局部變量；
一個局部變量儘可能只用在一件事物上，而不要用在多件事物上，以便於理解；
通常採用單行註釋的方式。

成員方法參數命名和註釋規範

成員方法參數的命名規範基本上與局部變量的命名規範相同。如： customer, inventoryItem, in , e等。

成員方法參數的文檔註釋：

成員方法參數的文檔註釋在成員方法的頭部註釋文檔中，它應包括如下內容：

該參數將被如何使用；
該參數的一些約束或其它前提條件；
若是僅憑以上的描述還不足以讓人容易理解該參數是什麼含義，能夠舉一個或多個例子加以說明。

類的命名和註釋規範

類的命名也是採用全英文單詞描述的方法，但它的第一個單詞的首字母必須大寫，其它單詞的首字母也要大寫。例如： public class Customer{….} public class OrderItems{…}

類的註釋文檔通常位於類的定義以前，它將包含以下內容：

本類的目的。其餘開發人員經常須要知道一個類的一般目的，以便決定其是不是他所須要的；
一些預知的bugs。通常狀況，若是有bugs存在，最好是對其進行相應的處理。但有時，咱們沒有更多的時間，或在本類中沒有必要對其進行處理，在目前而言不是過重要。在這種狀況下，應文檔給予說明。好比，類中的一個成員方法在傳遞一個負數的參數時不能正常工做，而正好應用程序有不會傳遞負的參數過來，在這種狀況下，就有一個預知的bugs，但沒有相應的處理，則應文檔說明，以便其餘開發人員清楚；
對本類的一些開發/維護的歷史信息的說明。好比日期、做者以及主要改變的內容等；
若是是線程類的話，應對其使用的併發控制策略做適當的描述，以及爲何採用這種策略而不是其它策略等信息。

接口的命名和註釋規範

接口的命名，其第一個字母必須是大寫的"I"，以代表它是一個接口，與其它類進行區別。剩下的部分與類的命名規範同樣，採用全英文單詞描述的方法，第一個單詞首字母大寫，其它單詞的首字母也大寫。例如：public interface IOrderItems{……..}

public interface ICustomer{…..}

接口的文檔註釋必須在接口被定義前給予說明，主要包括如下內容：

本接口定義的目的。當其餘開發人員使用一個接口的時候，他們經常須要了解本接口所封裝的內容以及其目的；
它將被怎樣的使用或者不能被怎樣的使用。其餘開發人員想知道本接口能被如何使用以及它不能被如何使用；

3．接口內的抽象成員方法的註釋，參照類的成員方法的註釋。

包的命名和文檔說明規範

包的命名有如下幾個規則：

包與子包之間或包與類之間用"ִ"來加以區別；
包名所有用小寫字母來命名，如： persistence.mapping.relational等；
若是一個包有可能在多個組織中使用，則使用本組織域名的逆轉方式來命名包。如：cn.com.mcm.www.persistence.mapping.relational 等。
包的命名須要有目的性，如：按模塊名來劃分，須要分層創建。

對於每個包，應該有一個或多個外部文檔來描述這個包。通常而言，文檔中應描述以下內容：

描述這個包是一個什麼樣的包，它有一些什麼樣的相關性等等；
包中的類和接口的簡單描述。應該有一個包中的類和接口的簡單列表，並對每個類和接口有相應的簡單描述，以便其餘開發人員都清楚的知道其包含的內容。

縮進規則
1. 控制結構的縮進
  程序應以縮進形式展示程序的塊結構和控制結構，在不影響展現程序結構的前提下儘量地減小縮進的層次。採用以下兩種縮進方式之一：

1）

if (expression ){

statements

}else{

statements

}

縮進的限制

一個程序的寬度若是超出頁寬或屏寬，這將是很難讀的，因此本規範要求使用折行縮進的方法、合併表達式或編寫子程序的方法來限制程序的寬度。

1）任何一個程序最大行寬不得超過80列，超過者應折行書寫。

2）建議一個函數的縮進不得超過5級，超過者應將其子塊寫爲子函數；

3）算法或程序自己的特性有特殊要求時，能夠超過5級。

jsp編碼規範
1. jsp 表示層應當儘量的瘦和簡單化。
2. 在儘量合理的狀況下，把業務邏輯從JSP中移走。具體於HTTP的邏輯（如，對Cookie的處理）屬於bean或支持類中，而不是JSP中。
3. 應當在JSP中避免使用頁面引入指令。import指令會促使類的實列化而不是jsp bean的實例化：
  用：<%@ page import = "com.java.util.List" %>
  而不用：<%@ page import = "com.java.util.*" %>
4. jsp不該該直接去訪問請求參數。
5. 應當避免設計既顯示錶單又處理結果的頁面。
6. jsp中應該避免使用out.println()發放來產生頁面內容。
7. jsp層不該該直接訪問數據，這包括JDBC數據庫訪問和EJB訪問。
8. 應當使用隱藏的註釋來阻止輸出的HTML過大。<%-- --%>
9. 在jsp中避免進行異常處理，應當使用一個錯誤頁面來處理不可以從中恢復的異常
10. 若是沒有充分的理由，就不要在jsp中定義方法

編寫測試代碼
1. 凡是用於臨時測試的全部成員方法均冠之前綴"test"，這樣將有利於快速的找到臨時用於測試的全部成員方法；
2. 全部用於測試其它成員方法的成員方法，命名規範和屬性方法一致，但必須有詳細註釋。
3. Main方法能夠除外。
性能優化常識規範
1. 前提約束
性能優化的原則是先讓程序運行起來，再考慮變得更快——但只有在本身必須這樣作、並且經證明在某部分代碼中的確存在一個性能瓶頸的時候，才應進行優化。進行優化時需使用專門的工具分析瓶頸。須要注意的是性能提高的隱含代價是本身的代碼變得難於理解，並且難於維護。
對於像字符串的鏈接操做不使用"＋"而使用專有方法 concat等其餘方法，這類問題，則不能稱爲性能優化，而只能叫作基本常識。這類問題的解決注意不能影響程序的可讀性和易維護性，如下是常見優化常識：
1. 運算時間參考值

詳見表9-1運算時間。

表 9-1 運算時間

運算	示例	標準時間
本地賦值	i=n;	1.0
實例賦值	this.i=n;	1.2
Int增值	i++;	1.5
Byte增值	b++;	2.0
Short增值	s++;	2.0
Float增值	f++;	2.0
Double增值	d++;	2.0
空循環	while(true) n++;	2.0
三元表達式	(x<0)?-x:x;	2.2
算術調用	Math.abs(x);	2.5
數組賦值	a[0]=n;	2.7
Long增值	l++;	3.5
方法調用	funct();	5.9
Throw 或者catch 違例	Try{throw e;}	320
同步方法調用	synchMethod();	570
新建對象	new Object();	980
新建數組	new int[10];	3100

java.lang.String

字串的開銷：字串鏈接運算符"＋"看似簡單，但實際須要消耗大量系統資源。編譯器可高效地鏈接字串，但變量字串卻要求可觀的處理器時間。該操做要建立並拆除一個StringBuffer對象以及一個String對象。

上述問題的一般解決方法是新建一個StringBuffer（字串緩衝），用append方法追加自變量，而後用toString()將結果轉換回一個字串。當要追加多個字串，則可考慮直接使用一個字串緩衝——特別是能在一個循環裏重複利用它的時候。經過在每次循環裏禁止新建一個字串緩衝，可節省980單位的對象建立時間（見表9-1）。

更有效的解決辦法是：在構造 StringBuffer 時，應該粗略的估計出它最終的總長度。默認構造函數預設了16個字符的緩存容量。append()方法首先計算字符串追加完成後的總長度，若是這個總長度大於StringBuffer的存儲能力，append()方法調用私有的expandCapacity()方法。expandCapacity()方法在每次被調用時使StringBuffer存儲能力加倍，並把現有的字符數組內容複製到新的存儲空間。存儲能力的擴展，從而致使了兩次代價昂貴的複製操做。所以，咱們至少有一點能夠作得比編譯器更好，這就是分配一個初始存儲容量大於或者等於最終字符長度StringBuffer。