Android的一些命名規範

序言

剛上大學那會開始寫程序的時候,變量名都是a,b,x,y這些,寫着簡單,可是看起來很累,尤爲是別人看你的代碼的時候,簡直了。後來lz進了學校的ACM校隊,在那學習期間,命名被強制改好了許多,開始使用英文單詞做爲變量名了,好比student,teacher,兩個單詞拼湊在一塊兒時就用下劃線,等等,這樣看起來通熟易懂多了,也提升了代碼的可讀性。後來學習Java的時候,有了包名,類名,還有一系列的命名。佈局

問題

爲何咱們在寫代碼的時候須要正確的命名規範呢?
答:由於在真正的項目開發中咱們不是一我的在開發,而是一個團隊,若是沒有一個命名規範的話,那別人讀你的代碼就像是天書同樣。
複製代碼

下面咱們就來介紹一下Android的一些命名規範:學習

一、包名:採用反域名命名規則,所有使用小寫字母。一級包名爲com,二級包名爲xx(能夠是公司或則我的的隨便),三級包名根據應用進行命名,四級包名爲模塊名或層級名

例如:com.公司名稱簡寫.項目名稱簡寫.模塊名 動畫

包名的一些規範

二、類名:採用大駝峯命名法,儘可能避免縮寫,除非該縮寫是衆所周知的, 好比HTML,URL,若是類名稱中包含單詞縮寫,則單詞縮寫的每一個字母均應大寫。

例如:LoginActivity spa

類名的一些規範

三、接口:命名規則與類同樣採用大駝峯命名法,多以able或ible結尾

例如:interface Runna ble;interface Accessible。3d

四、方法:動詞或動名詞,採用小駝峯命名法

例如:onCreate(),run() code

方法名的一些規範

五、變量:採用小駝峯命名法。類中控件名稱必須與xml佈局id保持一致。

用統一的量詞經過在結尾處放置一個量詞,就可建立更加統一的變量,它們更容易理解,也更容易搜索。例如,請使用strCustomerFirst和strCustomerLast,而不要使用strFirstCustomer和strLastCustomer。cdn

量詞列表:量詞後綴說明
First  一組變量中的第一個
Last   一組變量中的最後一個
Next   一組變量中的下一個變量
Prev   一組變量中的上一個
Cur    一組變量中的當前變量
複製代碼

六、常量:所有大寫,採用下劃線命名法。

例如:MIN_WIDTH,MAX_HEIGHTxml

七、資源文件(圖片drawable文件夾下):所有小寫,採用下劃線命名法,加前綴區分

命名模式:activity名稱_邏輯名稱/common_邏輯名稱,若是有多種形態如按鈕等除外如btn_xx.xml(selector) blog

資源文件的一些規範
資源文件後綴的一些規範

八、資源佈局文件(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、
複製代碼

九、動畫文件(anim文件夾下):所有小寫,採用下劃線命名法,加前綴區分。

注:前面爲動畫的類型,後面爲方向 接口

動畫文件的一些規範

十、資源ID(resourcesid):大小寫規範與方法名一致,採用小駝峯命名法。命名規範爲「資源控件的縮寫 名」+「變量名」。

注:頁面控件名稱應該和控件id名保持一致

strings.xml,colors.xml等中的id命名:
 命名模式:activity名稱_功能模塊名稱_邏輯名稱/activity名稱_邏輯名稱/common_邏輯名稱。
 strings.xml中,使用activity名稱註釋,將文件內容區分開來。
複製代碼

十一、 layout中的id命名:view縮寫_模塊名稱_view的邏輯名稱

view的縮寫詳情以下:

十二、activity中的view變量命名

命名模式爲:邏輯名稱+view縮寫
建議:若是layout文件很複雜,建議將layout分紅多個模塊,每一個模塊定義一個moduleViewHolder,其成員變量包含所屬view
複製代碼

僅供參考,具體仍是得根據需求來

公衆號:Android技術經驗分享
相關文章
相關標籤/搜索