Java代碼風(fēng)格冰蘑,掌握了這些你就可以成為架構(gòu)師

命名規(guī)約

1.命名符合本語(yǔ)言特性

Java中所有的代碼元素的命名均不能以下劃線或美元符號(hào)開始或結(jié)束呢岗。

2.命名體現(xiàn)代碼元素特征

要從名字上就知道代碼元素的屬性是什么,有利于快速理清代碼脈絡(luò)猴鲫。代碼的命名形式分為兩大類:即首字母大寫UpperCamelCase和首字母小寫lowerCamelCase,前者俗稱大駝峰谣殊,后者俗稱小駝峰拂共。
推薦在Java命名時(shí),以下列方式體現(xiàn)元素特征:
*包名統(tǒng)一小寫姻几,點(diǎn)分隔符之間有且僅有一個(gè)自然語(yǔ)義的英文單詞宜狐。統(tǒng)一使用單數(shù)形式势告。
*抽象類命名使用Abstract或Base開頭;異常類命名使用Exception結(jié)尾抚恒;測(cè)試?yán)坐Q以它要測(cè)試的類名開始咱台,以Test結(jié)尾。
*類型與中括號(hào)緊挨相連來(lái)定義數(shù)組俭驮。
*枚舉類名帶上Enum后綴回溺,枚舉成員名稱需要全大寫,單詞間用下劃線隔開混萝。

3.命名最好望文知意

代碼風(fēng)格展示

1.縮進(jìn)

在IDEA中設(shè)置Tab鍵為4個(gè)空格時(shí)遗遵,請(qǐng)勿勾選Use tab character;
在Eclipes中,必須勾選Insert spaces for tabs.

2.空格

空格的使用有如下約定:
(1)任何二目逸嘀、三目運(yùn)算符的左右兩邊都必須加一個(gè)空格
(2)注釋的雙斜線與注釋內(nèi)容之間有且僅有一個(gè)空格
(3)方法參數(shù)在定義和傳入時(shí)车要,多個(gè)參數(shù)逗號(hào)后面必須加空格
(4)沒有必要增加若干空格使變量的賦值等號(hào)與上一行對(duì)應(yīng)位置的等號(hào)對(duì)齊
(5)如果是大括號(hào)內(nèi)為空,則簡(jiǎn)潔地寫成{}即可崭倘,大括號(hào)中間無(wú)需換行和空格
(6)左右小括號(hào)與括號(hào)內(nèi)部地相鄰字符之間不要出現(xiàn)空格
(7)左大括號(hào)前需要加空格

3.空行

空行用來(lái)分割功能相似翼岁、邏輯內(nèi)聚、意思相近地代碼片段司光。在方法定義之后琅坡、屬性定義與方法之間、不同邏輯残家、不同語(yǔ)義榆俺、不同業(yè)務(wù)地代碼之間都需要通過空行來(lái)分隔。

4.換行

在代碼中需要限定每行地字符個(gè)數(shù)跪削,以便適應(yīng)顯示器地寬度。約定:?jiǎn)涡凶址麛?shù)不超過120個(gè)迂求,超出則需要換行碾盐,需要遵循如下原則:
1.第二行相對(duì)第一行縮進(jìn)4個(gè)空格,從第三行開始揩局,不再繼續(xù)縮進(jìn)
2.運(yùn)算符與下文一起換行
3.方法調(diào)用的點(diǎn)符號(hào)與下文一起換行
4.方法調(diào)用中的多個(gè)參數(shù)需要換行時(shí)毫玖,在逗號(hào)后換行
5.在括號(hào)前不要換行

5.方法行數(shù)限制

約定單行方法的總行數(shù)不超過80行。

控制語(yǔ)句

1.在if 凌盯、else付枫、for、while驰怎、do-while等語(yǔ)句中必須使用大括號(hào)

即使只有一行代碼阐滩,也要加上大括號(hào)

2.在條件表達(dá)式中不允許有賦值才做,也不允許在判斷表達(dá)式中出現(xiàn)復(fù)雜的邏輯組合
3.多層嵌套不能超過3層
4.避免采用取反邏輯運(yùn)算符

取反邏輯運(yùn)算符不易理解

代碼注釋

注釋三要素

1.Nothing is strange

代碼中不能沒有注釋县忌!

2.Less is more

首先掂榔,代碼的注釋一定是精華中的精華继效!
其次,注釋要簡(jiǎn)練装获,不能長(zhǎng)篇大論瑞信。
最后,一些簡(jiǎn)單方法常識(shí)性的方法無(wú)需注釋

3.Advance with the times

任何對(duì)于代碼的修改穴豫,都應(yīng)該同時(shí)修改注釋

注釋格式

1.Javadoc規(guī)范

使用文檔注釋(/** */)的格式凡简,方便生成文檔。
這里特別強(qiáng)調(diào)的是枚舉的注釋精肃,枚舉的注釋是必須要有的秤涩,因?yàn)椋?br> 1.枚舉實(shí)在太特殊了,它的代碼極其穩(wěn)定
2.注釋的內(nèi)容不僅限于解釋屬性值的含義肋杖,還可以包括注意事項(xiàng)溉仑、業(yè)務(wù)邏輯
3.枚舉類的刪除或者修改都存在很大的風(fēng)險(xiǎn)

2.簡(jiǎn)單注釋
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市状植,隨后出現(xiàn)的幾起案子浊竟,更是在濱河造成了極大的恐慌,老刑警劉巖津畸,帶你破解...
    沈念sama閱讀 217,509評(píng)論 6 504
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件振定,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡肉拓,警方通過查閱死者的電腦和手機(jī)后频,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,806評(píng)論 3 394
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)暖途,“玉大人卑惜,你說(shuō)我怎么就攤上這事∽な郏” “怎么了露久?”我有些...
    開封第一講書人閱讀 163,875評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)欺栗。 經(jīng)常有香客問我毫痕,道長(zhǎng),這世上最難降的妖魔是什么迟几? 我笑而不...
    開封第一講書人閱讀 58,441評(píng)論 1 293
  • 正文 為了忘掉前任消请,我火速辦了婚禮,結(jié)果婚禮上类腮,老公的妹妹穿的比我還像新娘臊泰。我一直安慰自己,他們只是感情好蚜枢,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,488評(píng)論 6 392
  • 文/花漫 我一把揭開白布因宇。 她就那樣靜靜地躺著七婴,像睡著了一般。 火紅的嫁衣襯著肌膚如雪察滑。 梳的紋絲不亂的頭發(fā)上打厘,一...
    開封第一講書人閱讀 51,365評(píng)論 1 302
  • 那天,我揣著相機(jī)與錄音贺辰,去河邊找鬼户盯。 笑死,一個(gè)胖子當(dāng)著我的面吹牛饲化,可吹牛的內(nèi)容都是我干的莽鸭。 我是一名探鬼主播,決...
    沈念sama閱讀 40,190評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼吃靠,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼硫眨!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起巢块,我...
    開封第一講書人閱讀 39,062評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤礁阁,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后族奢,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體姥闭,經(jīng)...
    沈念sama閱讀 45,500評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,706評(píng)論 3 335
  • 正文 我和宋清朗相戀三年越走,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了棚品。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,834評(píng)論 1 347
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡廊敌,死狀恐怖铜跑,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情骡澈,我是刑警寧澤锅纺,帶...
    沈念sama閱讀 35,559評(píng)論 5 345
  • 正文 年R本政府宣布,位于F島的核電站秧廉,受9級(jí)特大地震影響伞广,放射性物質(zhì)發(fā)生泄漏拣帽。R本人自食惡果不足惜疼电,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,167評(píng)論 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望减拭。 院中可真熱鬧蔽豺,春花似錦、人聲如沸拧粪。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,779評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至魄鸦,卻和暖如春宴杀,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背拾因。 一陣腳步聲響...
    開封第一講書人閱讀 32,912評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工旺罢, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人绢记。 一個(gè)月前我還...
    沈念sama閱讀 47,958評(píng)論 2 370
  • 正文 我出身青樓扁达,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親蠢熄。 傳聞我的和親對(duì)象是個(gè)殘疾皇子跪解,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,779評(píng)論 2 354

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

  • 更新時(shí)間:2016/5/13 介紹 本文檔所提供的編碼規(guī)范,適用于主要的Python發(fā)行版中組成標(biāo)準(zhǔn)庫(kù)的Pytho...
    超net閱讀 5,861評(píng)論 0 15
  • 貢獻(xiàn)者的代碼風(fēng)格 下面的代碼樣式是嚴(yán)格的規(guī)則签孔,而不是準(zhǔn)則或建議叉讥。不符合這些規(guī)則的Android應(yīng)用通常不會(huì)被接受。...
    AlexMofer閱讀 747評(píng)論 0 1
  • 這篇文章講安卓項(xiàng)目和代碼風(fēng)格指南骏啰,非常有參考價(jià)值节吮。為了方便大家查閱,把原文翻譯了一下判耕。英文原文點(diǎn)這里 1. 項(xiàng)目指...
    Jdqm閱讀 1,068評(píng)論 0 30
  • 格式規(guī)范 命名規(guī)則:規(guī)范避免單字母命名透绩。命名應(yīng)具備描述性使用駝峰式命名對(duì)象、函數(shù)和實(shí)例(首字母小寫)使用帕斯卡式命...
    iOS收藏家閱讀 859評(píng)論 0 0
  • 行業(yè)壁熄,地域帚豪,國(guó)別,個(gè)性草丧。狸臣。。 難怪有思考發(fā)笑之說(shuō)昌执。 還是道德經(jīng)說(shuō)的好烛亦,反者道之動(dòng)啊
    許中陽(yáng)閱讀 298評(píng)論 1 0