Android開發(fā)命名規(guī)范情龄,有它就夠了

還記得剛開始coding的時候迄汛,命名都是漢語拼音捍壤,所以有的時候想看懂它的意思,就要讀一遍甚至好幾遍才知道鞍爱,這還是在你小學(xué)拼音過關(guān)的基礎(chǔ)上鹃觉。這樣的話,在代碼的審查和修改過程中就會浪費(fèi)不少不必要的時間睹逃。如果你是獨(dú)立開發(fā)還好盗扇,可是如果是團(tuán)隊分工合作,這樣讓你的同事去看你的代碼就更加吃力了沉填,因?yàn)榇蠹抑g的編程方式不一樣疗隶,所以,在開發(fā)過程中翼闹,命名規(guī)范統(tǒng)一尤為重要斑鼻,最好是團(tuán)隊中統(tǒng)一好大家命名方法,這樣對于日后的工作會輕松很多猎荠。

命名規(guī)范作為編碼一大標(biāo)準(zhǔn)卵沉,往小了說,可以反映一個程序員的代碼潔癖法牲,往大了說可能間接影響到你的職業(yè)生涯的高度(注意這里絕逼不是危言聳聽)史汗。所以,本文就從Android的角度來談?wù)劥a的命名規(guī)范拒垃,希望對大家有所幫助停撞。

良好的編碼規(guī)范是不可能缺少注釋的,注釋是軟件可讀性的具體體現(xiàn)悼瓮。程序注釋量一般占程序編碼量的20%戈毒,軟件工程要求不少于20%。其內(nèi)容主要是函數(shù)的功能横堡、目的埋市、算法等說明,參數(shù)說明命贴、返回值說明等道宅。其中公用函數(shù)、公用類的聲明必須由注解說明其使用方法和設(shè)計思路胸蛛,當(dāng)然選擇恰當(dāng)?shù)拿袷侥軌驇椭惆咽虑榻忉尩酶宄垡稹.?dāng)然了,注釋一般包括類注釋葬项,方法注釋變量注釋泞当。

我覺得這里在講解命名規(guī)范前,有必要先粗略介紹下當(dāng)前主要的標(biāo)識符命名法和英文縮寫規(guī)則民珍。

標(biāo)識符命名法

標(biāo)識符命名法主要有四種:

1駝峰(Camel)命名法:又稱小駝峰命名法襟士,除首單詞外盗飒,其余所有單詞的第一個字母大寫。

2帕斯卡(pascal)命名法:又稱大駝峰命名法陋桂,所有單詞的第一個字母大寫

3下劃線命名法:單詞與單詞間用下劃線做間隔逆趣。

4匈牙利命名法:廣泛應(yīng)用于微軟編程環(huán)境中,在以Pascal命名法的變量前附加小寫序列說明該變量的類型章喉。 量的取名方式為: + + 范圍前綴汗贫,類型前綴,限定詞秸脱。

注意這里標(biāo)識符命名有個不成文的原則:盡可能的用最少的字符而又能完整的表達(dá)標(biāo)識符的含義落包。

英文縮寫原則:

1 較短的單詞可通過去掉“元音”形成縮寫

2 較長的單詞可取單詞的頭幾個字母形成縮寫

3 此外還有一些約定成俗的英文單詞縮寫.

下面為常見的英文單詞縮寫:


常見英文單詞縮寫

程序中使用單詞縮寫原則:盡量不要用縮寫,除非該縮寫是約定俗成的摊唇。

命名規(guī)范:

1(packages): 采用反域名命名規(guī)則咐蝇,全部使用小寫字母。一級包名為com巷查,二級包名為xx(可以是公司或則個人的隨便)有序,三級包名根據(jù)應(yīng)用進(jìn)行命名(如myapp),四級包名為模塊名或?qū)蛹壝?/p>


包名命名規(guī)范

2(classes):名詞岛请,采用大駝峰命名法旭寿,盡量避免縮寫,除非該縮寫是眾所周知的崇败, ?比如HTML,URL盅称,如果類名稱中包含單詞縮寫,則單詞縮寫的每個字母均應(yīng)大寫后室。


類名命名規(guī)范

3接口(interface):命名規(guī)則與類一樣采用大駝峰命名法缩膝,多以大寫的I(interface縮寫)開頭或者able或ible結(jié)尾,如interface Runnable ;interface Accessible 岸霹。

4方法(methods):動詞或動名詞疾层,采用小駝峰命名法例如:onCreate(),run()


方法命名規(guī)范

5變量(variables)采用小駝峰命名法。類中控件名稱必須與xml布局id保持一致贡避。

用統(tǒng)一的量詞通過在結(jié)尾處放置一個量詞痛黎,就可創(chuàng)建更加統(tǒng)一的變量,它們更容易理解贸桶,也更容易搜索舅逸。例如,請使用strCustomerFirst和strCustomerLast皇筛,而不要使用strFirstCustomer和strLastCustomer。

量詞列表:量詞后綴說明

First ?一組變量中的第一個

Last ? 一組變量中的最后一個

Next ? 一組變量中的下一個變量

Prev ? 一組變量中的上一個

Cur ? ?一組變量中的當(dāng)前變量

6常量(Constants)全部大寫,采用下劃線命名法.例如:MIN_WIDTH

7資源文件(圖片drawable文件夾下):全部小寫坠七,采用下劃線命名法水醋,加前綴區(qū)分

命名模式:activity名稱_邏輯名稱/common_邏輯名稱

如果有多種形態(tài)如按鈕等除外如btn_xx.xml(selector)


命名后綴:


8資源布局文件(XML文件(layout布局文件)):

全部小寫旗笔,采用下劃線命名法

1).contentview命名, Activity默認(rèn)布局,以去掉后綴的Activity類進(jìn)行命名拄踪。不加后綴:

功能模塊.xml

例如:main.xml蝇恶、more.xml、settings.xml

或者:activity_功能模塊.xml

例如:activity_main.xml惶桐、activity_more.xml

2).Dialog命名:dialog_描述.xml

例如:dlg_hint.xml

3).PopupWindow命名:ppw_描述.xml

例如:ppw _info.xml

4). 列表項(xiàng)命名listitem_描述.xml

例如:listitem_city.xml

5).包含項(xiàng):include_模塊.xml

例如:include_head.xml撮弧、include_bottom.xml

6).a(chǎn)dapter的子布局:功能模塊_item.xml

例如:main_item.xml、

9動畫文件(anim文件夾下):全部小寫姚糊,采用下劃線命名法贿衍,加前綴區(qū)分。

//前面為動畫的類型救恨,后面為方向


10資源ID(resourcesid):大小寫規(guī)范與方法名一致贸辈,采用小駝峰命名法。命名規(guī)范為“資源控件的縮寫 ?名”+“變量名”肠槽。注意:頁面控件名稱應(yīng)該和控件id名保持一致strings.xml擎淤,colors.xml等中的id命名:

命名模式:activity名稱_功能模塊名稱_邏輯名稱/activity名稱_邏輯名稱/common_邏輯名稱strings.xml中,使用activity名稱注釋秸仙,將文件內(nèi)容區(qū)分開來

11layout中控件視圖的id命名

命名模式為:view縮寫_模塊名稱_view的邏輯名稱

view的縮寫詳情如下:


12activity中的view變量命名

命名模式為:邏輯名稱+view縮寫

建議:如果layout文件很復(fù)雜嘴拢,建議將layout分成多個模塊,每個模塊定義一個moduleViewHolder寂纪,其成員變量包含所屬view

13styles.xml:將layout中不斷重現(xiàn)的style提煉出通用的style通用組件席吴,放到styles.xml中;

14使用layer-list和selector

Android編碼其他規(guī)范建議

1.java代碼中不出現(xiàn)中文弊攘,最多注釋中可以出現(xiàn)中文

2.局部變量命名抢腐、靜態(tài)成員變量命名時只能包含字母,單詞首字母除第一個外襟交,都為大寫迈倍,其他字母都為小寫

3.常量命名時只能包含字母和下劃線_,字母全部大寫捣域,單詞之間用_隔開

4.圖片盡量分拆成多個可重用的圖片

5.服務(wù)端可以實(shí)現(xiàn)的眼坏,就不要放在客戶端

6.引用第三方庫要慎重漩绵,避免應(yīng)用大容量的第三方庫,導(dǎo)致客戶端包非常大

7.處理應(yīng)用全局異常和錯誤,將錯誤以郵件的形式發(fā)送給服務(wù)端

8.圖片的.9處理

9.使用靜態(tài)變量方式實(shí)現(xiàn)界面間共享要慎重

10.Log(系統(tǒng)名稱模塊名稱接口名稱趟济,詳細(xì)描述)

11.單元測試(邏輯測試、界面測試)

12.不要重用父類的handler贯溅,對應(yīng)一個類的handler也不應(yīng)該讓其子類用到糕篇,否則會導(dǎo)致message.what沖突

13.activity中在一個View.OnClickListener中處理所有的邏輯

14.strings.xml中使用%1$s實(shí)現(xiàn)字符串的通配

15.如果多個Activity中包含共同的UI或者邏輯處理,那么可以提煉一個CommonActivity,把通用部分叫由它來處理弟蚀,其他activity只要繼承它即可

16.數(shù)據(jù)一定要效驗(yàn)蚤霞,例如字符型轉(zhuǎn)數(shù)字型,如果轉(zhuǎn)換失敗一定要有缺省值义钉;

以上分門別類的列舉了你在Android開發(fā)中經(jīng)常會用到的一些“命名規(guī)范”昧绣,之所以打上引號,就是說這些所謂的規(guī)范并不是說你不這樣用程序就跑不起來捶闸,不違法也不有悖于道德夜畴,但是這些都是業(yè)內(nèi)前輩們留下來的精神文明產(chǎn)物,所以在你有更好的解決辦法之前删壮,請先繼承起來吧贪绘,畢竟我們的目標(biāo)就是:擼得一手漂亮簡潔高效的代碼!



掃碼進(jìn)行關(guān)注
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末醉锅,一起剝皮案震驚了整個濱河市兔簇,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌硬耍,老刑警劉巖垄琐,帶你破解...
    沈念sama閱讀 206,723評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異经柴,居然都是意外死亡狸窘,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,485評論 2 382
  • 文/潘曉璐 我一進(jìn)店門坯认,熙熙樓的掌柜王于貴愁眉苦臉地迎上來翻擒,“玉大人,你說我怎么就攤上這事牛哺÷” “怎么了?”我有些...
    開封第一講書人閱讀 152,998評論 0 344
  • 文/不壞的土叔 我叫張陵引润,是天一觀的道長巩趁。 經(jīng)常有香客問我,道長淳附,這世上最難降的妖魔是什么议慰? 我笑而不...
    開封第一講書人閱讀 55,323評論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮奴曙,結(jié)果婚禮上别凹,老公的妹妹穿的比我還像新娘。我一直安慰自己洽糟,他們只是感情好炉菲,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,355評論 5 374
  • 文/花漫 我一把揭開白布堕战。 她就那樣靜靜地躺著,像睡著了一般颁督。 火紅的嫁衣襯著肌膚如雪践啄。 梳的紋絲不亂的頭發(fā)上浇雹,一...
    開封第一講書人閱讀 49,079評論 1 285
  • 那天沉御,我揣著相機(jī)與錄音,去河邊找鬼昭灵。 笑死吠裆,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的烂完。 我是一名探鬼主播试疙,決...
    沈念sama閱讀 38,389評論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼抠蚣!你這毒婦竟也來了祝旷?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,019評論 0 259
  • 序言:老撾萬榮一對情侶失蹤嘶窄,失蹤者是張志新(化名)和其女友劉穎怀跛,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體柄冲,經(jīng)...
    沈念sama閱讀 43,519評論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡吻谋,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,971評論 2 325
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了现横。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片漓拾。...
    茶點(diǎn)故事閱讀 38,100評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖戒祠,靈堂內(nèi)的尸體忽然破棺而出骇两,到底是詐尸還是另有隱情,我是刑警寧澤姜盈,帶...
    沈念sama閱讀 33,738評論 4 324
  • 正文 年R本政府宣布低千,位于F島的核電站,受9級特大地震影響贩据,放射性物質(zhì)發(fā)生泄漏栋操。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,293評論 3 307
  • 文/蒙蒙 一饱亮、第九天 我趴在偏房一處隱蔽的房頂上張望矾芙。 院中可真熱鬧,春花似錦近上、人聲如沸剔宪。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,289評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽葱绒。三九已至感帅,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間地淀,已是汗流浹背失球。 一陣腳步聲響...
    開封第一講書人閱讀 31,517評論 1 262
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留帮毁,地道東北人实苞。 一個月前我還...
    沈念sama閱讀 45,547評論 2 354
  • 正文 我出身青樓,卻偏偏與公主長得像烈疚,于是被迫代替她去往敵國和親黔牵。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,834評論 2 345

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