Java命名規範

定義規範的目的是爲了使項目的代碼樣式統一，使程序有良好的可讀性。

包的命名　 （所有小寫，由域名定義）

Java包的名字都是由小寫單詞組成。可是因爲Java面向對象編程的特性，每一名Java程序員都 能夠編寫屬於本身的Java包，爲了保障每一個Java包命名的惟一性，在最新的Java編程規範中，要求程序員在本身定義的包的名稱以前加上惟一的前綴。 因爲互聯網上的域名稱是不會重複的，因此程序員通常採用本身在互聯網上的域名稱做爲本身程序包的惟一前綴。 
例如：net.frontfree.javagroup

類的命名 （單詞首字母大寫）

根據約定，Java類名一般以大寫字母開頭，若是類名稱由多個單詞組成，則每一個單詞的首字母均應爲大 寫例如TestPage；若是類名稱中包含單詞縮寫，則這個所寫詞的每一個字母均應大寫，如：XMLExample,還有一點命名技巧就是因爲類是設計用來 表明對象的，因此在命名類時應儘可能選擇名詞。 　　 
例如： Graphics

方法的命名 （首字母小寫，字母開頭大寫）

方法的名字的第一個單詞應以小寫字母做爲開頭，後面的單詞則用大寫字母開頭。 
例如：drawImage

常量的命名 （所有大寫 ，常加下劃線）
常量的名字應該都使用大寫字母，而且指出該常量完整含義。若是一個常量名稱由多個單詞組成，則應該用下劃線來分割這些單詞。 
例如：MAX_VALUE

參數的命名

參數的命名規範和方法的命名規範相同，並且爲了不閱讀程序時形成迷惑，請在儘可能保證參數名稱爲一個單詞的狀況下使參數的命名儘量明確。

Javadoc註釋

Java除了能夠採用咱們常見的註釋方式以外，Java語言規範還定義了一種特殊的註釋，也就是咱們 所說的Javadoc註釋，它是用來記錄咱們代碼中的API的。Javadoc註釋是一種多行註釋，以/**開頭，而以*/結束，註釋能夠包含一些 HTML標記符和專門的關鍵詞。使用Javadoc 註釋的好處是編寫的註釋能夠被自動轉爲在線文檔，省去了單獨編寫程序文檔的麻煩。 
例如：

/** 
* This is an example of 
* Javadoc 
* @author darchon 
* @version 0.1, 10/11/2002 
*/

在每一個程序的最開始部分，通常都用Javadoc註釋對程序的整體描述以及版權信息，以後在主程序中 能夠爲每一個類、接口、方法、字段添加 Javadoc註釋，每一個註釋的開頭部分先用一句話歸納該類、接口、方法、字段所完成的功能，這句話應單獨佔據一行以突出其歸納做用，在這句話後面能夠跟 隨更加詳細的描述段落。在描述性段落以後還能夠跟隨一些以Javadoc註釋標籤開頭的特殊段落，例如上面例子中的@auther和@version，這 些段落將在生成文檔中以特定方式顯示。

變量和常量命名

變量的命名

主要的的命名規範有如下三種：
Camel 標記法:首字母是小寫的,接下來的單詞都以大寫字母開頭
Pascal 標記法:首字母是大寫的,接下來的單詞都以大寫字母開頭
匈牙利標記法:在以Pascal標記法的變量前附加小寫序列說明該變量的類型

在Java咱們通常使用匈牙利標記法，基本結構爲scope_typeVariableName，它 使用1-3字符前綴來表示數據類型，3個字符的前綴必須小寫，前綴後面是由表意性強的一個單詞或多個單詞組成的名字，並且每一個單詞的首寫字母大寫，其它字 母小寫，這樣保證了對變量名可以進行正確的斷句。例如，定義一個整形變量，用來記錄文檔數量：intDocCount，其中int代表數據類型，後面爲表 意的英文名，每一個單詞首字母大寫。這樣，在一個變量名就能夠反映出變量類型和變量所存儲的值的意義兩方面內容，這使得代碼語句可讀性強、更加容易理解。 byte、int、char、long、float、 double、boolean和short。

數據類型/前綴(附)
byte b
char c
short sh
int i
long l
char c
string s
float f
double d
hashtable h
[] arr
List lst
Vector v
StringBuffer sb
Boolean b
Byte bt
Map map
Object ob

對於在多個函數內都要使用的全局變量，在前面再增長「g_」。例如一個全局的字符串變量：g_strUserInfo。

在變量命名時要注意如下幾點：

· 選擇有意義的名字，注意每一個單詞首字母要大寫。

· 在一段函數中不使用同一個變量表示先後意義不一樣的兩個數值。

· i、j、k等只做爲小型循環的循環索引變量。

· 避免用Flag來命名狀態變量。

· 用Is來命名邏輯變量，如：blnFileIsFound。經過這種給布爾變量確定形式的命名方式，使得其它開發人員可以更爲清楚的理解布爾變量所表明的意義。

· 若是須要的話，在變量最後附加計算限定詞，如：curSalesSum。

· 命名不相包含，curSales和curSalesSum。

· static final 變量(常量)的名字應該都大寫，而且指出完整含義。

· 若是須要對變量名進行縮寫時，必定要注意整個代碼中縮寫規則的一致性。例如，若是在代碼的某些區域中使用intCnt，而在另外一些區域中又使用intCount，就會給代碼增長沒必要要的複雜性。建議變量名中儘可能不要出現縮寫。

· 經過在結尾處放置一個量詞，就可建立更加統一的變量，它們更容易理解，也更容易搜索。例如，請使用 strCustomerFirst和strCustomerLast，而不要使用strFirstCustomer和strLastCustomer。常 用的量詞後綴有：First（一組變量中的第一個）、Last（一組變量中的最後一個）、Next（一組變量中的下一個變量）、Prev（一組變量中的上 一個）、Cur（一組變量中的當前變量）。

· 爲每一個變量選擇最佳的數據類型，這樣即能減小對內存的需求量，加快代碼的執行速度，又會下降出錯的可能性。用於變量的數據類型可能會影響該變量進行計算所產生的結果。在這種狀況下，編譯器不會產生運行期錯誤，它只是迫使該值符合數據類型的要求。這類問題極難查找。

· 儘可能縮小變量的做用域。若是變量的做用域大於它應有的範圍，變量可繼續存在，而且在再也不須要該變量後的很長時間內仍然佔用資源。它們的主要問題是，任何類 中的任何方法都能對它們進行修改，而且很難跟蹤到底是何處進行修改的。佔用資源是做用域涉及的一個重要問題。對變量來講，儘可能縮小做用域將會對應用程序的 可靠性產生巨大的影響。

關於常量的命名方法，在JAVA代碼中，不管何時，均提倡應用常量取代數字、固定字符串。也就是 說，程序中除0，1之外，儘可能不該該出現其餘數字。常量能夠集中在程序開始部分定義或者更寬的做用域內，名字應該都使用大寫字母，而且指出該常量完整含 義。若是一個常量名稱由多個單詞組成，則應該用下劃線「_」來分割這些單詞如：NUM_DAYS_IN_WEEK、MAX_VALUE。