Java文件名及其他命名規(guī)則

http://bbs.csdn.net/topics/70157841? 關(guān)于JAVA源文件命名的問題

Java文件命名:

java程序是由類組成的猬膨;

java應(yīng)用程序必須有一個(gè)包含main方法的public類馍悟,main方法是程序的入口袍嬉;

java源文件的命名規(guī)則:

如果有public類赤嚼,那么源文件名就是public類名(一個(gè)文件中只能有一個(gè)public類)调限,而類名命名規(guī)則是:類的名字必須由大寫字母開頭而單詞中的其他字母均為小寫仰泻;如果類名稱由多個(gè)單詞組成伐憾,則每個(gè)單詞的首字母均應(yīng)為大寫,如果類名稱中包含單詞縮寫秒际,則這個(gè)所寫詞的每個(gè)字母均應(yīng)大寫悬赏,命名類時(shí)應(yīng)盡量選擇名詞。

如果沒有public類娄徊,就和遵循文件名命名規(guī)則闽颇;

1.一個(gè).java文件只能有1個(gè)public class

(暗示可以沒有)

2.如果有public class,那么文件名必須與修飾符為public的類名相同

(暗示,沒有的話文件名可以隨便起)

其他:

定義規(guī)范的目的是為了使項(xiàng)目的代碼樣式統(tǒng)一,使程序有良好的可讀性寄锐。

包的命名(全部小寫兵多,由域名定義)

Java包的名字都是由小寫單詞組成。但是由于Java面向?qū)ο缶幊痰奶匦蚤掀停恳幻鸍ava程序員都 可以編寫屬于自己的Java包剩膘,為了保障每個(gè)Java包命名的唯一性,在最新的Java編程規(guī)范中盆顾,要求程序員在自己定義的包的名稱之前加上唯一的前綴怠褐。 由于互聯(lián)網(wǎng)上的域名稱是不會(huì)重復(fù)的,所以程序員一般采用自己在互聯(lián)網(wǎng)上的域名稱作為自己程序包的唯一前綴您宪。

例如:net.frontfree.javagroup

類的命名(單詞首字母大寫)

根據(jù)約定奈懒,Java類名通常以大寫字母開頭奠涌,如果類名稱由多個(gè)單詞組成,則每個(gè)單詞的首字母均應(yīng)為大 寫例如TestPage磷杏;如果類名稱中包含單詞縮寫溜畅,則這個(gè)所寫詞的每個(gè)字母均應(yīng)大寫,如:XMLExample,還有一點(diǎn)命名技巧就是由于類是設(shè)計(jì)用來 代表對(duì)象的极祸,所以在命名類時(shí)應(yīng)盡量選擇名詞慈格。

例如: Graphics

方法的命名(首字母小寫,字母開頭大寫)

方法的名字的第一個(gè)單詞應(yīng)以小寫字母作為開頭遥金,后面的單詞則用大寫字母開頭浴捆。

例如:drawImage

常量的命名(全部大寫 ,常加下劃線)

常量的名字應(yīng)該都使用大寫字母汰规,并且指出該常量完整含義汤功。如果一個(gè)常量名稱由多個(gè)單詞組成,則應(yīng)該用下劃線來分割這些單詞溜哮。

例如:MAX_VALUE

參數(shù)的命名

參數(shù)的命名規(guī)范和方法的命名規(guī)范相同滔金,而且為了避免閱讀程序時(shí)造成迷惑,請(qǐng)?jiān)诒M量保證參數(shù)名稱為一個(gè)單詞的情況下使參數(shù)的命名盡可能明確茂嗓。

Javadoc注釋

Java除了可以采用我們常見的注釋方式之外餐茵,Java語言規(guī)范還定義了一種特殊的注釋,也就是我們 所說的Javadoc注釋述吸,它是用來記錄我們代碼中的API的忿族。Javadoc注釋是一種多行注釋,以/**開頭蝌矛,而以*/結(jié)束道批,注釋可以包含一些 HTML標(biāo)記符和專門的關(guān)鍵詞。使用Javadoc 注釋的好處是編寫的注釋可以被自動(dòng)轉(zhuǎn)為在線文檔入撒,省去了單獨(dú)編寫程序文檔的麻煩隆豹。

例如:

/**

* This is an example of

* Javadoc

* @author darchon

* @version 0.1, 10/11/2002

*/

在每個(gè)程序的最開始部分,一般都用Javadoc注釋對(duì)程序的總體描述以及版權(quán)信息茅逮,之后在主程序中 可以為每個(gè)類璃赡、接口、方法献雅、字段添加 Javadoc注釋碉考,每個(gè)注釋的開頭部分先用一句話概括該類、接口挺身、方法侯谁、字段所完成的功能,這句話應(yīng)單獨(dú)占據(jù)一行以突出其概括作用,在這句話后面可以跟 隨更加詳細(xì)的描述段落良蒸。在描述性段落之后還可以跟隨一些以Javadoc注釋標(biāo)簽開頭的特殊段落技扼,例如上面例子中的@auther和@version,這 些段落將在生成文檔中以特定方式顯示嫩痰。

變量和常量命名

變量的命名

主要的的命名規(guī)范有以下三種:

Camel 標(biāo)記法:首字母是小寫的,接下來的單詞都以大寫字母開頭

Pascal 標(biāo)記法:首字母是大寫的,接下來的單詞都以大寫字母開頭

匈牙利標(biāo)記法:在以Pascal標(biāo)記法的變量前附加小寫序列說明該變量的類型

在Java我們一般使用匈牙利標(biāo)記法,基本結(jié)構(gòu)為scope_typeVariableName窍箍,它 使用1-3字符前綴來表示數(shù)據(jù)類型串纺,3個(gè)字符的前綴必須小寫,前綴后面是由表意性強(qiáng)的一個(gè)單詞或多個(gè)單詞組成的名字椰棘,而且每個(gè)單詞的首寫字母大寫纺棺,其它字 母小寫,這樣保證了對(duì)變量名能夠進(jìn)行正確的斷句邪狞。例如祷蝌,定義一個(gè)整形變量,用來記錄文檔數(shù)量:intDocCount帆卓,其中int表明數(shù)據(jù)類型巨朦,后面為表 意的英文名,每個(gè)單詞首字母大寫剑令。這樣糊啡,在一個(gè)變量名就可以反映出變量類型和變量所存儲(chǔ)的值的意義兩方面內(nèi)容,這使得代碼語句可讀性強(qiáng)吁津、更加容易理解棚蓄。 byte、int碍脏、char梭依、long、float典尾、 double役拴、boolean和short。

數(shù)據(jù)類型/前綴(附)

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

對(duì)于在多個(gè)函數(shù)內(nèi)都要使用的全局變量急黎,在前面再增加“g_”扎狱。例如一個(gè)全局的字符串變量:g_strUserInfo。

在變量命名時(shí)要注意以下幾點(diǎn):

· 選擇有意義的名字勃教,注意每個(gè)單詞首字母要大寫淤击。

· 在一段函數(shù)中不使用同一個(gè)變量表示前后意義不同的兩個(gè)數(shù)值。

· i故源、j污抬、k等只作為小型循環(huán)的循環(huán)索引變量。

· 避免用Flag來命名狀態(tài)變量。

· 用Is來命名邏輯變量印机,如:blnFileIsFound矢腻。通過這種給布爾變量肯定形式的命名方式,使得其它開發(fā)人員能夠更為清楚的理解布爾變量所代表的意義射赛。

· 如果需要的話多柑,在變量最后附加計(jì)算限定詞,如:curSalesSum楣责。

· 命名不相包含竣灌,curSales和curSalesSum。

· static final 變量(常量)的名字應(yīng)該都大寫秆麸,并且指出完整含義初嘹。

· 如果需要對(duì)變量名進(jìn)行縮寫時(shí),一定要注意整個(gè)代碼中縮寫規(guī)則的一致性沮趣。例如屯烦,如果在代碼的某些區(qū)域中使用intCnt,而在另一些區(qū)域中又使用intCount房铭,就會(huì)給代碼增加不必要的復(fù)雜性驻龟。建議變量名中盡量不要出現(xiàn)縮寫。

· 通過在結(jié)尾處放置一個(gè)量詞育叁,就可創(chuàng)建更加統(tǒng)一的變量迅脐,它們更容易理解,也更容易搜索豪嗽。例如谴蔑,請(qǐng)使用 strCustomerFirst和strCustomerLast,而不要使用strFirstCustomer和strLastCustomer龟梦。常 用的量詞后綴有:First(一組變量中的第一個(gè))隐锭、Last(一組變量中的最后一個(gè))、Next(一組變量中的下一個(gè)變量)计贰、Prev(一組變量中的上 一個(gè))钦睡、Cur(一組變量中的當(dāng)前變量)。

· 為每個(gè)變量選擇最佳的數(shù)據(jù)類型躁倒,這樣即能減少對(duì)內(nèi)存的需求量荞怒,加快代碼的執(zhí)行速度,又會(huì)降低出錯(cuò)的可能性秧秉。用于變量的數(shù)據(jù)類型可能會(huì)影響該變量進(jìn)行計(jì)算所產(chǎn)生的結(jié)果褐桌。在這種情況下,編譯器不會(huì)產(chǎn)生運(yùn)行期錯(cuò)誤象迎,它只是迫使該值符合數(shù)據(jù)類型的要求荧嵌。這類問題極難查找呛踊。

· 盡量縮小變量的作用域。如果變量的作用域大于它應(yīng)有的范圍啦撮,變量可繼續(xù)存在谭网,并且在不再需要該變量后的很長(zhǎng)時(shí)間內(nèi)仍然占用資源。它們的主要問題是赃春,任何類 中的任何方法都能對(duì)它們進(jìn)行修改愉择,并且很難跟蹤究竟是何處進(jìn)行修改的。占用資源是作用域涉及的一個(gè)重要問題聘鳞。對(duì)變量來說薄辅,盡量縮小作用域?qū)?huì)對(duì)應(yīng)用程序的 可靠性產(chǎn)生巨大的影響。

關(guān)于常量的命名方法抠璃,在JAVA代碼中,無論什么時(shí)候脱惰,均提倡應(yīng)用常量取代數(shù)字搏嗡、固定字符串。也就是 說拉一,程序中除0采盒,1以外,盡量不應(yīng)該出現(xiàn)其他數(shù)字蔚润。常量可以集中在程序開始部分定義或者更寬的作用域內(nèi)磅氨,名字應(yīng)該都使用大寫字母,并且指出該常量完整含 義嫡纠。如果一個(gè)常量名稱由多個(gè)單詞組成烦租,則應(yīng)該用下劃線“_”來分割這些單詞如:NUM_DAYS_IN_WEEK、MAX_VALUE除盏。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末叉橱,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子者蠕,更是在濱河造成了極大的恐慌窃祝,老刑警劉巖,帶你破解...
    沈念sama閱讀 221,430評(píng)論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件踱侣,死亡現(xiàn)場(chǎng)離奇詭異粪小,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)抡句,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,406評(píng)論 3 398
  • 文/潘曉璐 我一進(jìn)店門探膊,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人玉转,你說我怎么就攤上這事突想。” “怎么了?”我有些...
    開封第一講書人閱讀 167,834評(píng)論 0 360
  • 文/不壞的土叔 我叫張陵猾担,是天一觀的道長(zhǎng)袭灯。 經(jīng)常有香客問我,道長(zhǎng)绑嘹,這世上最難降的妖魔是什么稽荧? 我笑而不...
    開封第一講書人閱讀 59,543評(píng)論 1 296
  • 正文 為了忘掉前任,我火速辦了婚禮工腋,結(jié)果婚禮上姨丈,老公的妹妹穿的比我還像新娘。我一直安慰自己擅腰,他們只是感情好蟋恬,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,547評(píng)論 6 397
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著趁冈,像睡著了一般歼争。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上渗勘,一...
    開封第一講書人閱讀 52,196評(píng)論 1 308
  • 那天沐绒,我揣著相機(jī)與錄音,去河邊找鬼旺坠。 笑死乔遮,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的取刃。 我是一名探鬼主播蹋肮,決...
    沈念sama閱讀 40,776評(píng)論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼蝉衣!你這毒婦竟也來了括尸?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,671評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤病毡,失蹤者是張志新(化名)和其女友劉穎濒翻,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體啦膜,經(jīng)...
    沈念sama閱讀 46,221評(píng)論 1 320
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡有送,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,303評(píng)論 3 340
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了僧家。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片雀摘。...
    茶點(diǎn)故事閱讀 40,444評(píng)論 1 352
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖八拱,靈堂內(nèi)的尸體忽然破棺而出阵赠,到底是詐尸還是另有隱情涯塔,我是刑警寧澤,帶...
    沈念sama閱讀 36,134評(píng)論 5 350
  • 正文 年R本政府宣布清蚀,位于F島的核電站匕荸,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏枷邪。R本人自食惡果不足惜榛搔,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,810評(píng)論 3 333
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望东揣。 院中可真熱鬧践惑,春花似錦、人聲如沸嘶卧。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,285評(píng)論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽芥吟。三九已至穷娱,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間运沦,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,399評(píng)論 1 272
  • 我被黑心中介騙來泰國打工配深, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留携添,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,837評(píng)論 3 376
  • 正文 我出身青樓篓叶,卻偏偏與公主長(zhǎng)得像烈掠,于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子缸托,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,455評(píng)論 2 359

推薦閱讀更多精彩內(nèi)容