定義java命名規(guī)范的目的是為了使項目的代碼樣式統(tǒng)一蜜氨,使程序有良好的可讀性械筛。
包的命名 ?(全部小寫,由域名定義)
Java包的名字都是由小寫單詞組成飒炎。但是由于Java面向對象編程的特性变姨,每一名Java程序員都 可以編寫屬于自己的Java包,為了保障每個Java包命名的唯一性厌丑,在最新的Java編程規(guī)范中定欧,要求程序員在自己定義的包的名稱之前加上唯一的前綴渔呵。 由于互聯(lián)網上的域名稱是不會重復的,所以程序員一般采用自己在互聯(lián)網上的域名稱作為自己程序包的唯一前綴砍鸠。? 例如:lbz.sdust.me
類的命名?(單詞首字母大寫)
根據約定扩氢,Java類名通常以大寫字母開頭,如果類名稱由多個單詞組成爷辱,則每個單詞的首字母均應為大 寫例如TestPage录豺;如果類名稱中包含單詞縮寫,則這個所寫詞的每個字母均應大寫饭弓,如:XMLExample,還有一點命名技巧就是由于類是設計用來 代表對象的双饥,所以在命名類時應盡量選擇名詞。 ? 例如: Graphics
方法的命名?(首字母小寫弟断,字母開頭大寫)
方法的名字的第一個單詞應以小寫字母作為開頭咏花,后面的單詞則用大寫字母開頭。? 例如:drawImage
常量的命名?(全部大寫 阀趴,常加下劃線) 常量的名字應該都使用大寫字母昏翰,并且指出該常量完整含義。如果一個常量名稱由多個單詞組成刘急,則應該用下劃線來分割這些單詞棚菊。? 例如:MAX_VALUE
參數(shù)的命名
參數(shù)的命名規(guī)范和方法的命名規(guī)范相同,而且為了避免閱讀程序時造成迷惑叔汁,請在盡量保證參數(shù)名稱為一個單詞的情況下使參數(shù)的命名盡可能明確统求。
Javadoc注釋
Java除了可以采用我們常見的注釋方式之外,Java語言規(guī)范還定義了一種特殊的注釋据块,也就是我們 所說的Javadoc注釋码邻,它是用來記錄我們代碼中的API的。Javadoc注釋是一種多行注釋瑰钮,以/**開頭冒滩,而以*/結束微驶,注釋可以包含一些 HTML標記符和專門的關鍵詞浪谴。使用Javadoc 注釋的好處是編寫的注釋可以被自動轉為在線文檔,省去了單獨編寫程序文檔的麻煩因苹。?例如:
/**?* This is an example of?* Javadoc?* @author darchon?* @version 0.1, 10/11/2002?*/
在每個程序的最開始部分苟耻,一般都用Javadoc注釋對程序的總體描述以及版權信息,之后在主程序中 可以為每個類扶檐、接口凶杖、方法、字段添加 Javadoc注釋款筑,每個注釋的開頭部分先用一句話概括該類智蝠、接口腾么、方法、字段所完成的功能杈湾,這句話應單獨占據一行以突出其概括作用解虱,在這句話后面可以跟 隨更加詳細的描述段落。在描述性段落之后還可以跟隨一些以Javadoc注釋標簽開頭的特殊段落漆撞,例如上面例子中的@auther和@version殴泰,這 些段落將在生成文檔中以特定方式顯示。
變量的命名
主要的的命名規(guī)范有以下三種: Camel 標記法:首字母是小寫的,接下來的單詞都以大寫字母開頭 Pascal 標記法:首字母是大寫的,接下來的單詞都以大寫字母開頭 匈牙利標記法:在以Pascal標記法的變量前附加小寫序列說明該變量的類型
在Java我們一般使用匈牙利標記法浮驳,基本結構為scope_typeVariableName悍汛,它 使用1-3字符前綴來表示數(shù)據類型,3個字符的前綴必須小寫至会,前綴后面是由表意性強的一個單詞或多個單詞組成的名字离咐,而且每個單詞的首寫字母大寫,其它字 母小寫奋献,這樣保證了對變量名能夠進行正確的斷句健霹。例如,定義一個整形變量瓶蚂,用來記錄文檔數(shù)量:intDocCount糖埋,其中int表明數(shù)據類型,后面為表 意的英文名窃这,每個單詞首字母大寫瞳别。這樣,在一個變量名就可以反映出變量類型和變量所存儲的值的意義兩方面內容杭攻,這使得代碼語句可讀性強祟敛、更加容易理解。 byte兆解、int馆铁、char、long锅睛、float埠巨、 double、boolean和short现拒。
數(shù)據類型/前綴(附) 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
對于在多個函數(shù)內都要使用的全局變量辣垒,在前面再增加“g_”。例如一個全局的字符串變量:g_strUserInfo印蔬。
關于常量的命名方法勋桶,在JAVA代碼中,無論什么時候,均提倡應用常量取代數(shù)字例驹、固定字符串捐韩。也就是 說,程序中除0鹃锈,1以外奥帘,盡量不應該出現(xiàn)其他數(shù)字。常量可以集中在程序開始部分定義或者更寬的作用域內仪召,名字應該都使用大寫字母寨蹋,并且指出該常量完整含 義。如果一個常量名稱由多個單詞組成扔茅,則應該用下劃線“_”來分割這些單詞如:NUM_DAYS_IN_WEEK已旧、MAX_VALUE。