java編程規范介紹

相關推薦

java編程規范介紹

　　一、(Package)包的命名

　　Java包的名字都是由小寫單詞組成。但是由于Java面向對象編程的特性，每一名Java程序員都可以編寫屬于自己的Java包，為了保障每個 Java包命名的唯一性，在最新的Java編程規范中，要求程序員在自己定義的包的名稱之前加上唯一的前綴。由于互聯網上的域名稱是不會重復的，所以程序員一般采用自己在互聯網上的域名稱作為自己程序包的唯一前綴。

　　例如： net.frontfree.javagroup

　　二、(Class)類的命名

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

　　例如： Circle

　　三、方法的命名

　　方法的名字的第一個單詞應以小寫字母作為開頭，后面的單詞則用大寫字母開頭。

　　例如： sendMessge

　　四、參數的命名

　　參數的命名規范和方法的命名規范相同，而且為了避免閱讀程序時造成迷惑，請在盡量保證參數名稱為一個單詞的情況下使參數的命名盡可能明確。

　　五、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，這些段落將在生成文檔中以特定方式顯示。

　　六、變量命名

　　變量命名應該采用首字母小寫，其他字母首字母大寫的方式。

　　· Static Final 變量的名字應該都大寫，并且指出完整含義。

　　· 如果需要對變量名進行縮寫時，一定要注意整個代碼中縮寫規則的一致性。例如，如果在代碼的某些區域中使用intCnt，而在另一些區域中又使用intCount，就會給代碼增加不必要的復雜性。建議變量名中盡量不要出現縮寫。

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

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

　　· 盡量縮小變量的作用域。如果變量的作用域大于它應有的范圍，變量可繼續存在，并且在不再需要該變量后的很長時間內仍然占用資源。它們的主要問題是，任何類中的任何方法都能對它們進行修改，并且很難跟蹤究竟是何處進行修改的。占用資源是作用域涉及的一個重要問題。對變量來說，盡量縮小作用域將會對應用程序的可靠性產生巨大的影響。

　　七、關于常量的命名方法

　　在JAVA代碼中，無論什么時候，均提倡應用常量取代數字、固定字符串。也就是說，程序中除0，1以外，盡量不應該出現其他數字。常量可以集中在程序開始部分定義或者更寬的作用域內，名字應該都使用大寫字母，并且指出該常量完整含義。如果一個常量名稱由多個單詞組成

　　，則應該用下劃線“_”來分割這些單詞如：NUM_DAYS_IN_WEEK、MAX_VALUE。

　　八、推薦的命名

　　1、類名推薦

　　當要區別接口和實現類的時候，可以在類的后面加上“Impl”。例如： interface Container ,class ContainerImpl

　　class Container3PImpl

　　class ContainerYICTImpl

　　2、Exception類名推薦

　　Exception類最好能用“Exception”做為類命名的結尾。

【java編程規范介紹】相關文章：

Java編程風格與命名規范08-07