Java代碼規(guī)范

一炭序、為什么要有編碼規(guī)范(Why Have Code Conventions)
編碼規(guī)范對于程序員而言尤為重要啤覆,有以下幾個原因:

  • 一個軟件的生命周期中,80%的花費在于維護(hù) - 幾乎沒有任何一個軟件惭聂,在其整個生命周期中城侧,均由最初的開發(fā)人員來維護(hù) - 編碼規(guī)范可以改善軟件的可讀性,可以讓程序員盡快而徹底地理解新的代碼 - 如果你將源碼作為產(chǎn)品發(fā)布彼妻,就需要確任它是否被很好的打包并且清晰無誤,一如你已構(gòu)建的 其它任何產(chǎn)品豆茫。為了執(zhí)行規(guī)范侨歉,每個軟件開發(fā)人員必須一致遵守編碼規(guī)范
    二Java 源文件(.java文件)
    每個 Java 源文件都包含一個單一的公共類或接口。若私有類和接口與一個公共類相關(guān)聯(lián)揩魂,可以 將它們和公共類放入同一個源文件幽邓。公共類必須是這個文件中的第一個類或接口。
    Java 源文件還遵循以下規(guī)則:
    1 開頭注釋火脉,其中列出類名牵舵、版本信息柒啤、日期和版權(quán) 聲明
    例如:
Paste_Image.png

2 包和引入語句
在多數(shù) Java 源文件中,第一個非注釋行是包語句畸颅。在它之后可以跟引入語句担巩。例如:
package java.awt;
import java.awt.peer.CanvasPeer;
3 類和接口聲明
下表描述了類和接口聲明的各個部分以及它們出現(xiàn)的先后次序。

Paste_Image.png

三没炒、排版規(guī)范
1涛癌、4 個空格常被作為縮進(jìn)排版的一個單位。
2送火、行長度
盡量避免一行的長度超過 80 個字符拳话,因為很多終端和工具不能很好處理。
注意:用于文檔中的例子應(yīng)該使用更短的行長种吸,長度一般不超過 70 個字符弃衍。
3、 換行
當(dāng)一個表達(dá)式無法容納在一行內(nèi)時坚俗,可以依據(jù)如下一般規(guī)則斷開之:

  • 在一個逗號后面斷開
  • 在一個操作符前面斷開
  • 寧可選擇較高級別(higher-level)的斷開镜盯,而非較低級別(lower-level)的斷開
  • 新的一行應(yīng)該與上一行同一級別表達(dá)式的開頭處對齊
  • 如果以上規(guī)則導(dǎo)致你的代碼混亂或者使你的代碼都堆擠在右邊,那就代之以縮進(jìn) 8 個空格坦冠。
    以下是斷開方法調(diào)用的一些例子:
Paste_Image.png

以下是兩個斷開算術(shù)表達(dá)式的例子形耗。前者更好,因為斷開處位于括號表達(dá)式的外邊辙浑,這是個較高 級別的斷開激涤。

Paste_Image.png

以下是兩個縮進(jìn)方法聲明的例子。前者是常規(guī)情形判呕。后者若使用常規(guī)的縮進(jìn)方式將會使第二行和 第三行移得很靠右倦踢,所以代之以縮進(jìn) 8 個空格
//CONVENTIONAL INDENTATION someMethod(int anArg, Object anotherArg, String yetAnotherArg, Object andStillAnother) { ... }
//INDENT 8 SPACES TO AVOID VERY DEEP INDENTS private static synchronized horkingLongMethodName(int anArg, Object anotherArg, String yetAnotherArg, Object andStillAnother) { ... }
以下是兩個縮進(jìn)方法聲明的例子。前者是常規(guī)情形侠草。后者若使用常規(guī)的縮進(jìn)方式將會使第二行和 第三行移得很靠右辱挥,所以代之以縮進(jìn) 8 個空格

Paste_Image.png

四、語句
1边涕、每行至多包含一條語句
int a; int b;(這樣的代碼最好不要出現(xiàn))
2晤碘、復(fù)合語句是包含在大括號中的語句序列,形如"{ 語句 }"功蜓。例如下面各段园爷。

  • 被括其中的語句應(yīng)該較之復(fù)合語句縮進(jìn)一個層次
  • 左大括號"{"應(yīng)位于復(fù)合語句起始行的行尾;右大括號"}"應(yīng)另起一行并與復(fù)合語句首行對齊式撼。
  • 大括號可以被用于所有語句童社,如果是單個語句,最好也是用大括號著隆,這樣便于添加語句而無需擔(dān)心由于忘了加括號而引入 bug扰楼。
    3呀癣、if語句的格式:
Paste_Image.png

五、空行
1 空行弦赖,空行將邏輯相關(guān)的代碼段分隔開项栏,以提高可讀性。
下列情況應(yīng)該總是使用兩個空行:

  • 一個源文件的兩個片段(section)之間 - 類聲明和接口聲明之間
    下列情況應(yīng)該總是使用一個空行:
  • 兩個方法之間
  • 方法內(nèi)的局部變量和方法的第一條語句之間
  • 一個方法內(nèi)的兩個邏輯段之間腾节,用以提高可讀性
    六忘嫉、命名規(guī)范
Paste_Image.png

·參考文獻(xiàn)《Java 語言編碼規(guī)范》

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市案腺,隨后出現(xiàn)的幾起案子庆冕,更是在濱河造成了極大的恐慌,老刑警劉巖劈榨,帶你破解...
    沈念sama閱讀 222,104評論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件访递,死亡現(xiàn)場離奇詭異,居然都是意外死亡同辣,警方通過查閱死者的電腦和手機(jī)拷姿,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,816評論 3 399
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來旱函,“玉大人响巢,你說我怎么就攤上這事“舴粒” “怎么了踪古?”我有些...
    開封第一講書人閱讀 168,697評論 0 360
  • 文/不壞的土叔 我叫張陵,是天一觀的道長券腔。 經(jīng)常有香客問我伏穆,道長,這世上最難降的妖魔是什么纷纫? 我笑而不...
    開封第一講書人閱讀 59,836評論 1 298
  • 正文 為了忘掉前任枕扫,我火速辦了婚禮,結(jié)果婚禮上辱魁,老公的妹妹穿的比我還像新娘烟瞧。我一直安慰自己,他們只是感情好染簇,可當(dāng)我...
    茶點故事閱讀 68,851評論 6 397
  • 文/花漫 我一把揭開白布燕刻。 她就那樣靜靜地躺著,像睡著了一般剖笙。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上请唱,一...
    開封第一講書人閱讀 52,441評論 1 310
  • 那天弥咪,我揣著相機(jī)與錄音过蹂,去河邊找鬼。 笑死聚至,一個胖子當(dāng)著我的面吹牛酷勺,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播扳躬,決...
    沈念sama閱讀 40,992評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼脆诉,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了贷币?” 一聲冷哼從身側(cè)響起击胜,我...
    開封第一講書人閱讀 39,899評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎役纹,沒想到半個月后偶摔,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,457評論 1 318
  • 正文 獨居荒郊野嶺守林人離奇死亡促脉,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,529評論 3 341
  • 正文 我和宋清朗相戀三年辰斋,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片瘸味。...
    茶點故事閱讀 40,664評論 1 352
  • 序言:一個原本活蹦亂跳的男人離奇死亡宫仗,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出旁仿,到底是詐尸還是另有隱情藕夫,我是刑警寧澤,帶...
    沈念sama閱讀 36,346評論 5 350
  • 正文 年R本政府宣布丁逝,位于F島的核電站汁胆,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏霜幼。R本人自食惡果不足惜嫩码,卻給世界環(huán)境...
    茶點故事閱讀 42,025評論 3 334
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望罪既。 院中可真熱鬧铸题,春花似錦、人聲如沸琢感。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,511評論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽驹针。三九已至烘挫,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背饮六。 一陣腳步聲響...
    開封第一講書人閱讀 33,611評論 1 272
  • 我被黑心中介騙來泰國打工其垄, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人卤橄。 一個月前我還...
    沈念sama閱讀 49,081評論 3 377
  • 正文 我出身青樓绿满,卻偏偏與公主長得像,于是被迫代替她去往敵國和親窟扑。 傳聞我的和親對象是個殘疾皇子喇颁,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,675評論 2 359

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