Android的一些命名規范
序言
剛上大學那會開始寫程序的時候,變量名都是a,b,x,y這些,寫著簡單,但是看起來很累,尤其是別人看你的代碼的時候,簡直了。后來lz進了學校的ACM校隊,在那學習期間,命名被強制改好了許多,開始使用英文單詞作為變量名了,比如student,teacher,兩個單詞拼湊在一起時就用下劃線,等等,這樣看起來通熟易懂多了,也提高了代碼的可讀性。后來學習Java的時候,有了包名,類名,還有一系列的命名。
問題
為什么我們在寫代碼的時候需要正確的命名規范呢?
答:因為在真正的項目開發中我們不是一個人在開發,而是一個團隊,如果沒有一個命名規范的話,那別人讀你的代碼就像是天書一樣。
下面我們就來介紹一下Android的一些命名規范:
1、包名:采用反域名命名規則,全部使用小寫字母。一級包名為com,二級包名為xx(可以是公司或則個人的隨便),三級包名根據應用進行命名,四級包名為模塊名或層級名
例如:com.公司名稱簡寫.項目名稱簡寫.模塊名
包名的一些規范
2、類名:采用大駝峰命名法,盡量避免縮寫,除非該縮寫是眾所周知的, 比如HTML,URL,如果類名稱中包含單詞縮寫,則單詞縮寫的每個字母均應大寫。
例如:LoginActivity
類名的一些規范
3、接口:命名規則與類一樣采用大駝峰命名法,多以able或ible結尾
例如:interface Runna ble;interface Accessible。
4、方法:動詞或動名詞,采用小駝峰命名法
例如:onCreate(),run()
方法名的一些規范
5、變量:采用小駝峰命名法。類中控件名稱必須與xml布局id保持一致。
用統一的量詞通過在結尾處放置一個量詞,就可創建更加統一的變量,它們更容易理解,也更容易搜索。例如,請使用strCustomerFirst和strCustomerLast,而不要使用strFirstCustomer和strLastCustomer。
量詞列表:量詞后綴說明
First 一組變量中的第一個
Last 一組變量中的最后一個
Next 一組變量中的下一個變量
Prev 一組變量中的上一個
Cur 一組變量中的當前變量
6、常量:全部大寫,采用下劃線命名法。
例如:MIN_WIDTH,MAX_HEIGHT
7、資源文件(圖片drawable文件夾下):全部小寫,采用下劃線命名法,加前綴區分
命名模式:activity名稱 邏輯名稱/common 邏輯名稱,如果有多種形態如按鈕等除外如btn_xx.xml(selector)
資源文件的一些規范
資源文件后綴的一些規范
8、資源布局文件(XML文件(layout布局文件)):全部小寫,采用下劃線命名法
1).contentview命名, Activity默認布局,以去掉后綴的Activity類進行命名。不加后綴:
功能模塊.xml
例如:main.xml、more.xml、settings.xml
或則:activity_功能模塊.xml
例如:activity_main.xml、activity_more.xml
2).Dialog命名:dialog_描述.xml
例如:dlg_hint.xml
2).PopupWindow命名:ppw_描述.xml
例如:ppw _info.xml
3). 列表項命名listitem_描述.xml
例如:listitem_city.xml
4).包含項:include_模塊.xml
例如:include_head.xml、include_bottom.xml
5).adapter的子布局:功能模塊_item.xml
例如:main_item.xml、
9、動畫文件(anim文件夾下):全部小寫,采用下劃線命名法,加前綴區分。
注:前面為動畫的類型,后面為方向
動畫文件的一些規范
10、資源ID(resourcesid):大小寫規范與方法名一致,采用小駝峰命名法。命名規范為“資源控件的縮寫 名”+“變量名”。
注:頁面控件名稱應該和控件id名保持一致
strings.xml,colors.xml等中的id命名:
命名模式:activity名稱_功能模塊名稱_邏輯名稱/activity名稱_邏輯名稱/common_邏輯名稱。
strings.xml中,使用activity名稱注釋,將文件內容區分開來。
11、 layout中的id命名:view縮寫_模塊名稱_view的邏輯名稱
view的縮寫詳情如下:
12、activity中的view變量命名
命名模式為:邏輯名稱+view縮寫
建議:如果layout文件很復雜,建議將layout分成多個模塊,每個模塊定義一個moduleViewHolder,其成員變量包含所屬view
來自:http://www.jianshu.com/p/f663432ca60e