Java-開發命名規範

包的命名　     

Java包的名字都是由小寫單詞組成。但是由於Java面向對象編程的特性，每一名Java程序員都可以編寫屬於自己的Java包，爲了保障每個 Java包命名的唯一性，在最新的Java編程規範中，要求程序員在自己定義的包的名稱之前加上唯一的前綴。由於互聯網上的域名稱是不會重複的，所以程序員一般採用自己在互聯網上的域名稱作爲自己程序包的唯一前綴。     
例如：    net.frontfree.javagroup     

類的命名     

類的名字必須由大寫字母開頭而單詞中的其他字母均爲小寫；如果類名稱由多個單詞組成，則每個單詞的首字母均應爲大寫例如TestPage；如果類名稱中包含單詞縮寫，則這個所寫詞的每個字母均應大寫，如：XMLExample,還有一點命名技巧就是由於類是設計用來代表對象的，所以在命名類時應儘量選擇名詞。    　　   
例如：    Circle     

方法的命名     

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

常量的命名   

常量的名字應該都使用大寫字母，並且指出該常量完整含義。如果一個常量名稱由多個單詞組成，則應該用下劃線來分割這些單詞。   
例如：    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，這些段落將在生成文檔中以特定方式顯示。


變量和常量命名

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

變量類型和首字母對照關係如下表：

數據類型/對象類型 / 變量前綴 / 備註   

byte bye   
char chr   
float flt   
boolean bln 做布爾變量時，使用bln   
Integer/int int     
String str   
Single sng   
short sht   
Long/long lng   
Double/double dbl   
Currency cur   
Variant bln      astr      obj      vnt 做布爾變量用時，用bln，做字符串數組用時，用astr，做爲對象使用時，用obj，不確定時，用vnt。

對於數組，在數據類型的前綴前再增加一個a，例如字符串數組爲astr。對於在多個函數內都要使用的全局變量，在前面再增加“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。