還記得剛開始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>
2類(classes):名詞岛请,采用大駝峰命名法旭寿,盡量避免縮寫,除非該縮寫是眾所周知的崇败, ?比如HTML,URL盅称,如果類名稱中包含單詞縮寫,則單詞縮寫的每個字母均應(yīng)大寫后室。
3接口(interface):命名規(guī)則與類一樣采用大駝峰命名法缩膝,多以大寫的I(interface縮寫)開頭或者able或ible結(jié)尾,如interface Runnable ;interface Accessible 岸霹。
4方法(methods):動詞或動名詞疾层,采用小駝峰命名法例如:onCreate(),run()
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)就是:擼得一手漂亮簡潔高效的代碼!