- 相關(guān)推薦
Java命名規(guī)范介紹
Java定義這個規(guī)范的目的是讓項目中所有的文檔都看起來像一個人寫的,增加可讀性,減少項目組中因為換人而帶來的損失。下面是小編為大家搜索整理的Java命名規(guī)范介紹,希望大家能有所收獲,更多精彩內(nèi)容請及時關(guān)注我們應(yīng)屆畢業(yè)生考試網(wǎng)!
一、(Package)包的命名
Java包的名字都是由小寫單詞組成。但是由于Java面向?qū)ο缶幊痰奶匦,每一名Java程序員都可以編寫屬于自己的Java包,為了保障每個 Java包命名的唯一性,在最新的Java編程規(guī)范中,要求程序員在自己定義的包的名稱之前加上唯一的前綴。由于互聯(lián)網(wǎng)上的域名稱是不會重復(fù)的,所以程序員一般采用自己在互聯(lián)網(wǎng)上的域名稱作為自己程序包的唯一前綴。
例如: net.frontfree.javagroup
二、(Class)類的命名
類的名字必須由大寫字母開頭而單詞中的其他字母均為小寫;如果類名稱由多個單詞組成,則每個單詞的首字母均應(yīng)為大寫例如TestPage;如果類名稱中包含單詞縮寫,則這個所寫詞的每個字母均應(yīng)大寫,如:XMLExample,還有一點命名技巧就是由于類是設(shè)計用來代表對象的,所以在命名類時應(yīng)盡量選擇名詞。
例如: Circle
三、方法的命名
方法的名字的第一個單詞應(yīng)以小寫字母作為開頭,后面的單詞則用大寫字母開頭。
例如: sendMessge
四、參數(shù)的命名
參數(shù)的命名規(guī)范和方法的命名規(guī)范相同,而且為了避免閱讀程序時造成迷惑,請在盡量保證參數(shù)名稱為一個單詞的情況下使參數(shù)的命名盡可能明確。
五、Javadoc注釋
Java除了可以采用我們常見的注釋方式之外,Java語言規(guī)范還定義了一種特殊的注釋,也就是我們所說的Javadoc注釋,它是用來記錄我們代碼中的API的。Javadoc注釋是一種多行注釋,以/**開頭,而以*/結(jié)束,注釋可以包含一些HTML標(biāo)記符和專門的關(guān)鍵詞。使用Javadoc 注釋的好處是編寫的注釋可以被自動轉(zhuǎn)為在線文檔,省去了單獨編寫程序文檔的麻煩。
例如:
/**
* This is an example of
* Javadoc
*
* @author darchon
* @version 0.1, 10/11/2002
*/
在每個程序的最開始部分,一般都用Javadoc注釋對程序的總體描述以及版權(quán)信息,之后在主程序中可以為每個類、接口、方法、字段添加 Javadoc注釋,每個注釋的開頭部分先用一句話概括該類、接口、方法、字段所完成的功能,這句話應(yīng)單獨占據(jù)一行以突出其概括作用,在這句話后面可以跟隨更加詳細的描述段落。在描述性段落之后還可以跟隨一些以Javadoc注釋標(biāo)簽開頭的特殊段落,例如上面例子中的@auther和@version,這些段落將在生成文檔中以特定方式顯示。
六、變量命名
變量命名應(yīng)該采用首字母小寫,其他字母首字母大寫的方式。
· Static Final 變量的名字應(yīng)該都大寫,并且指出完整含義。
· 如果需要對變量名進行縮寫時,一定要注意整個代碼中縮寫規(guī)則的一致性。例如,如果在代碼的某些區(qū)域中使用intCnt,而在另一些區(qū)域中又使用intCount,就會給代碼增加不必要的復(fù)雜性。建議變量名中盡量不要出現(xiàn)縮寫。
· 通過在結(jié)尾處放置一個量詞,就可創(chuàng)建更加統(tǒng)一的變量,它們更容易理解,也更容易搜索。例如,請使用 strCustomerFirst和strCustomerLast,而不要使用strFirstCustomer和strLastCustomer。常用的量詞后綴有:First(一組變量中的第一個)、Last(一組變量中的最后一個)、Next(一組變量中的下一個變量)、Prev(一組變量中的上一個)、Cur(一組變量中的當(dāng)前變量)。
· 為每個變量選擇最佳的數(shù)據(jù)類型,這樣即能減少對內(nèi)存的需求量,加快代碼的執(zhí)行速度,又會降低出錯的可能性。用于變量的數(shù)據(jù)類型可能會影響該變量進行計算所產(chǎn)生的結(jié)果。在這種情況下,編譯器不會產(chǎn)生運行期錯誤,它只是迫使該值符合數(shù)據(jù)類型的要求。這類問題極難查找。
· 盡量縮小變量的作用域。如果變量的作用域大于它應(yīng)有的范圍,變量可繼續(xù)存在,并且在不再需要該變量后的很長時間內(nèi)仍然占用資源。它們的主要問題是,任何類中的任何方法都能對它們進行修改,并且很難跟蹤究竟是何處進行修改的。占用資源是作用域涉及的一個重要問題。對變量來說,盡量縮小作用域?qū)䦟?yīng)用程序的可靠性產(chǎn)生巨大的影響。
七、關(guān)于常量的命名方法
在JAVA代碼中,無論什么時候,均提倡應(yīng)用常量取代數(shù)字、固定字符串。也就是說,程序中除0,1以外,盡量不應(yīng)該出現(xiàn)其他數(shù)字。常量可以集中在程序開始部分定義或者更寬的作用域內(nèi),名字應(yīng)該都使用大寫字母,并且指出該常量完整含義。如果一個常量名稱由多個單詞組成,則應(yīng)該用下劃線“_”來分割這些單詞如:NUM_DAYS_IN_WEEK、MAX_VALUE。
八、推薦的命名
1、類名推薦
當(dāng)要區(qū)別接口和實現(xiàn)類的時候,可以在類的后面加上“Impl”。例如: interface Container ,class ContainerImpl
class Container3PImpl
class ContainerYICTImpl
2、Exception類名推薦
Exception類最好能用“Exception”做為類命名的結(jié)尾。
【Java命名規(guī)范介紹】相關(guān)文章:
Java 循環(huán)結(jié)構(gòu)介紹08-13
Java語言的優(yōu)點介紹07-01
介紹Java array接口10-06
JAVA語言的介紹及發(fā)展10-06
java布爾型介紹10-16
關(guān)于Java多線程介紹09-09
java圖片處理功能介紹06-23
Java虛擬機介紹07-12
java語言參數(shù)傳遞介紹06-12