Android 命名規(guī)范

《Android 命名規(guī)范》由會(huì)員分享，可在線閱讀，更多相關(guān)《Android 命名規(guī)范（10頁(yè)珍藏版）》請(qǐng)?jiān)谘b配圖網(wǎng)上搜索。

1、?Android 命名規(guī)范 （提高代碼可以讀性） 標(biāo)簽：?Android命名規(guī)范編碼習(xí)慣 2014-04-12 22:48?76988人閱讀?評(píng)論(31)?收藏?舉報(bào) ?分類： android（19）? 版權(quán)聲明：本文為博主原創(chuàng)文章，未經(jīng)博主允許不得轉(zhuǎn)載。 ? ? ? ?剛接觸android的時(shí)候，命名都是按照拼音來(lái)，所以有的時(shí)候想看懂命名的那個(gè)控件什么是什么用的，就要讀一遍甚至好幾遍才知道，這樣的話，在代碼的審查和修改過(guò)程中就會(huì)浪費(fèi)不少不必要的時(shí)間。如果就是我一個(gè)人開發(fā)，一個(gè)人維護(hù)的話還好，可是如果一個(gè)項(xiàng)目是團(tuán)隊(duì)分工合作，這樣讓你的同事去看你的代碼就更加吃力了，因?yàn)榇蠹抑g的編程

2、方式不一樣，所以，在開發(fā)過(guò)程中，命名規(guī)范統(tǒng)一尤為重要，最好是團(tuán)隊(duì)中統(tǒng)一好大家命名方法，這樣對(duì)于日后的工作會(huì)輕松很多。 ? ? ? ?在面試的時(shí)候，審核一個(gè)程序員的編程水平的時(shí)候，命名規(guī)范也是一大標(biāo)準(zhǔn)，所以，下面我就總結(jié)下我從網(wǎng)上別人的經(jīng)驗(yàn)和自己的感悟中收集總結(jié)的android命名規(guī)范，希望對(duì)大家有所幫助。 ? ? ? ?提醒：在命名規(guī)范的統(tǒng)一下，在加上注釋，這樣日后維護(hù)會(huì)高效快捷好多。 先初略介紹下當(dāng)前主要的標(biāo)識(shí)符命名法和英文縮寫規(guī)則：（這段別人那邊借鑒的） 在講解命名規(guī)范前，先初略介紹下當(dāng)前主要的標(biāo)識(shí)符命名法和英文縮寫規(guī)則。 標(biāo)識(shí)符命名法 標(biāo)識(shí)符命名法最要有四種:

3、1?駝峰(Camel)命名法:又稱小駝峰命名法，除首單詞外，其余所有單詞的第一個(gè)字母大寫。 2?帕斯卡(pascal)命名法:又稱大駝峰命名法，所有單詞的第一個(gè)字母大寫 3?下劃線命名法:單詞與單詞間用下劃線做間隔。 4?匈牙利命名法:廣泛應(yīng)用于微軟編程環(huán)境中，在以Pascal命名法的變量前附加小寫序列說(shuō)明該變量的類型。?量的取名方式為：?+??+?范圍前綴，類型前綴，限定詞。 個(gè)人覺得標(biāo)識(shí)符命名原則:盡可能的用最少的字符而又能完整的表達(dá)標(biāo)識(shí)符的含義。 英文縮寫原則： 1?較短的單詞可通過(guò)去掉“元音”形成縮

4、寫 2?較長(zhǎng)的單詞可取單詞的頭幾個(gè)字母形成縮寫 3?此外還有一些約定成俗的英文單詞縮寫. 下面為常見的英文單詞縮寫: 名稱 縮寫 icon ? ic?（主要用在app的圖標(biāo)） color ? cl（主要用于顏色值） divider di（主要用于分隔線，不僅包括Listview中的divider，還包括普通布局中的線） selector sl（主要用于某一view多種狀態(tài)，不僅包括Listview中的selector，還包括按鈕的selector） average avg background?? Bg（主要用于布局和子布局的背景） buffer bu

5、f control ctrl delete del document? doc error err escape esc increment inc infomation info initial? init image img Internationalization I18N length len library lib message msg password- pwd position pos server srv string str temp tmp window wnd(win) 程序中使用單詞縮寫

6、原則：不要用縮寫，除非該縮寫是約定俗成的。 命名規(guī)范： 1 ?包（packages）:?采用反域名命名規(guī)則，全部使用小寫字母。一級(jí)包名為com，二級(jí)包名為xx（可以是公司或則個(gè)人的隨便），三級(jí)包名根據(jù)應(yīng)用進(jìn)行命名，四級(jí)包名為模塊名或?qū)蛹?jí)名 包名 此包中包含 com.xx.應(yīng)用名稱縮寫.activities ?頁(yè)面用到的Activity類?(activities層級(jí)名用戶界面層) ?com.xx.應(yīng)用名稱縮寫.base ?頁(yè)面中每個(gè)Activity類共享的可以寫成一個(gè)i額BaseActivity類?(基礎(chǔ)共享的類) com.xx.應(yīng)用名稱縮寫.adapter ? ?頁(yè)

7、面用到的Adapter類?(適配器的類) com.xx.應(yīng)用名稱縮寫.tools ?此包中包含：公共工具方法類（tools模塊名） com.xx.應(yīng)用名稱縮寫.bean (或則?com.xx.應(yīng)用名稱縮寫.unity?) ?此包中包含：元素類 com.xx.應(yīng)用名稱縮寫.db ?數(shù)據(jù)庫(kù)操作類 com.xx.應(yīng)用名稱縮寫.view (或則?com.xx.應(yīng)用名稱縮寫.ui?) ?自定義的View類等 com.xx.應(yīng)用名稱縮寫.service ??? ?Service服務(wù) com.xx.應(yīng)用名稱縮寫.broadcast ? ?Broadcast服務(wù) 2 ?類

8、（classes）：名詞，采用大駝峰命名法，盡量避免縮寫，除非該縮寫是眾所周知的，??比如HTML,URL，如果類名稱中包含單詞縮寫，則單詞縮寫的每個(gè)字母均應(yīng)大寫。 類 描述 例如 activity?類 ?Aty或者Activity為后綴標(biāo)識(shí) ?歡迎頁(yè)面類WelcomeAty.或者WelcomeActivity Adapter類 ??Adp或者Adapte?為后綴標(biāo)識(shí) ?新聞詳情適配器NewtDetailAdp或則直接??NewDetailAdapter 解析類? ?Hlr為后綴標(biāo)識(shí) ?首頁(yè)解析類HomePosterHlr 公共方法類 ??Tools或Manager

9、為后綴標(biāo)識(shí) ?線程池管理類：ThreadPoolManager ????????????日志工具類：LogTools 數(shù)據(jù)庫(kù)類 ?以DBHelper后綴標(biāo)識(shí) ?新聞數(shù)據(jù)庫(kù)：NewDBHelper Service類 ?以Service為后綴標(biāo)識(shí) ?時(shí)間服務(wù)TimeService BroadcastReceive類 ? 以Broadcast為后綴標(biāo)識(shí) ?時(shí)間通知TimeBroadcast ContentProvider?? ?以Provider為后綴標(biāo)識(shí) ? 直接寫的共享基礎(chǔ)類 ?以Base開頭 BaseActivity,BaseFragment 3 ?接口

10、（interface）：命名規(guī)則與類一樣采用大駝峰命名法，多以able或ible結(jié)尾，如interface Runna?ble?; ?????????????????????interface Accessible?。 4 ?方法（methods）：動(dòng)詞或動(dòng)名詞，采用小駝峰命名法例如:onCreate(),run() 方法 說(shuō)明 initXX() ?初始化相關(guān)方法,使用init為前綴標(biāo)識(shí)，如初始化布局initView() isXX() ?checkXX()方法返回值為boolean型的請(qǐng)使用is或check為前綴標(biāo)識(shí) getXX() ?返回某個(gè)值的方法，使用get為前綴

11、標(biāo)識(shí) processXX()? ?對(duì)數(shù)據(jù)進(jìn)行處理的方法，盡量使用process為前綴標(biāo)識(shí) displayXX() ?彈出提示框和提示信息，使用display為前綴標(biāo)識(shí) saveXX() ?與保存數(shù)據(jù)相關(guān)的，使用sav為e前綴標(biāo)識(shí) resetXX() ?對(duì)數(shù)據(jù)重組的，使用reset前綴標(biāo)識(shí) clearXX() ?清除數(shù)據(jù)相關(guān)的 removeXXX()? ?清除數(shù)據(jù)相關(guān)的 drawXXX() ?繪制數(shù)據(jù)或效果相關(guān)的，使用draw前綴標(biāo)識(shí) 5 ?變量（variables）采用小駝峰命名法。類中控件名稱必須與xml布局id保持一致。 用統(tǒng)一的量詞通過(guò)在結(jié)尾處

12、放置一個(gè)量詞，就可創(chuàng)建更加統(tǒng)一的變量，它們更容易理解，也更容易搜索。例如，請(qǐng)使用strCustomerFirst和strCustomerLast，而不要使用strFirstCustomer和strLastCustomer。 量詞列表：量詞后綴說(shuō)明 First??一組變量中的第一個(gè) Last???一組變量中的最后一個(gè) Next???一組變量中的下一個(gè)變量 Prev???一組變量中的上一個(gè) Cur????一組變量中的當(dāng)前變量 ? 6 ?常量（Constants）全部大寫,采用下劃線命名法.例如：MIN_WIDTH 7 ?資源文件（圖片drawable文件夾下）：全部小寫，

13、采用下劃線命名法，加前綴區(qū)分 命名模式：activity名稱_邏輯名稱/common_邏輯名稱 如果有多種形態(tài)如按鈕等除外如btn_xx.xml（selector） 名稱 功能 btn_xx ?按鈕圖片使用btn_整體效果（selector） btn_xx_normal ?按鈕圖片使用btn_正常情況效果 btn_xx_press ?按鈕圖片使用btn_點(diǎn)擊時(shí)候效果 bg_head ?背景圖片使用bg_功能_說(shuō)明 def_search_cell ?默認(rèn)圖片使用def_功能_說(shuō)明 icon_more_help ?圖標(biāo)圖片使用icon_功能_說(shuō)明 seg_list

14、_line ?具有分隔特征的圖片使用seg_功能_說(shuō)明 sel_ok ?選擇圖標(biāo)使用sel_功能_說(shuō)明 命名后綴： 后綴 說(shuō)明 unit ?在使用xml的tilemode來(lái)配圖片時(shí)，element圖片使用此后綴 nor ?圖片的狀態(tài)，代表普通狀態(tài) hl ?圖片的狀態(tài)，代表高亮狀態(tài) press ?圖片的狀態(tài)，代表按下狀態(tài) select ?圖片的狀態(tài)，代表其所占的view被選中 unselect ?圖片的狀態(tài)，代表其所占的view沒(méi)有被選中 ? ? ? ? ? ? ? ? ? ? 8?????資源布局文件（XML文件（layout布局文

15、件））： ?全部小寫，采用下劃線命名法 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 2)．PopupWindow命名：ppw_描述.xml ???

16、????例如：ppw _info.xml 3).?列表項(xiàng)命名listitem_描述.xml ???????例如：listitem_city.xml 4)．包含項(xiàng)：include_模塊.xml ???????例如：include_head.xml、include_bottom.xml 5)．a(chǎn)dapter的子布局：功能模塊_item.xml ???????例如：main_item.xml、 9???動(dòng)畫文件（anim文件夾下）：全部小寫，采用下劃線命名法，加前綴區(qū)分。 ? //前面為動(dòng)畫的類型，后面為方向 動(dòng)畫命名例子 規(guī)范寫法 備注 fade_in 淡入 ?

17、 fade_out 淡出 ? push_down_in 從下方推入 ? push_down_out 從下方推出 ? push_left 推像左方 ? slide_in_from_top 從頭部滑動(dòng)進(jìn)入 ? zoom_enter 變形進(jìn)入 ? slide_in 滑動(dòng)進(jìn)入 ? shrink_to_middle 中間縮小 ? 10????資源ID（resourcesid）：大小寫規(guī)范與方法名一致，采用小駝峰命名法。命名規(guī)范為“資源控件的縮寫??名”+“變量名”。注意：頁(yè)面控件名稱應(yīng)該和控件id名保持一致 ?strings.xml，colors.x

18、ml等中的id命名： 命名模式：activity名稱_功能模塊名稱_邏輯名稱/activity名稱_邏輯名稱/common_邏輯名稱 strings.xml中，使用activity名稱注釋，將文件內(nèi)容區(qū)分開來(lái) 11 ? layout中的id命名 命名模式為：view縮寫_模塊名稱_view的邏輯名稱 view的縮寫詳情如下： 控件 縮寫 LayoutView lv RelativeView rv TextView tv Button btn ImageButton???????? imgBtn ImageView????????? mgView?或則?

19、iv CheckBox??????????? chk RadioButton???????? rdoBtn analogClock???????? anaClk DigtalClock???????? dgtClk DatePicker????????? dtPk EditText ?????????? edtTxt TimePicker ???????? tmPk toggleButton ?????? tglBtn ProgressBar? proBar SeekBar???????????????????????????? skBar AutoC

20、ompleteTextView autoTxt ZoomControls??????? zmCtl VideoView?????????? vdoVi WdbView???????????? webVi RantingBar????????? ratBar Tab???????????????? tab Spinner???????????? spn Chronometer???????? cmt ScollView?????????? sclVi TextSwitch????????? txtSwt ImageSwitch???????? imgSw

21、t listView??????????? lVi?或則lv ExpandableList????? epdLt MapView???????????? mapVi ? ? ? 12.activity中的view變量命名 命名模式為：邏輯名稱+view縮寫 建議：如果layout文件很復(fù)雜，建議將layout分成多個(gè)模塊，每個(gè)模塊定義一個(gè)moduleViewHolder，其成員變量包含所屬view 13.styles.xml：

22、將layout中不斷重現(xiàn)的style提煉出通用的style通用組件，放到styles.xml中； 14.使用layer-list和selector Android編碼規(guī)范建議（別人弄的覺得蠻有道理） 1.java代碼中不出現(xiàn)中文，最多注釋中可以出現(xiàn)中文 2.局部變量命名、靜態(tài)成員變量命名 只能包含字母，單詞首字母除第一個(gè)外，都為大寫，其他字母都為小寫 3.常量命名 只能包含字母和_，字母全部大寫，單詞之間用_隔開 4.圖片盡量分拆成多個(gè)可重用的圖片 5.服務(wù)端可以實(shí)現(xiàn)的，就不要放在客戶端 6.引用第三方庫(kù)要慎重，避免應(yīng)用大容量的第三方庫(kù)，導(dǎo)致客戶端包非常大 7.處理應(yīng)

23、用全局異常和錯(cuò)誤，將錯(cuò)誤以郵件的形式發(fā)送給服務(wù)端 8.圖片的.9處理 9.使用靜態(tài)變量方式實(shí)現(xiàn)界面間共享要慎重 10.Log(系統(tǒng)名稱模塊名稱接口名稱，詳細(xì)描述) 11.單元測(cè)試（邏輯測(cè)試、界面測(cè)試） 12.不要重用父類的handler，對(duì)應(yīng)一個(gè)類的handler也不應(yīng)該讓其子類用到，否則會(huì)導(dǎo)致message.what沖突 13.activity中在一個(gè)View.OnClickListener中處理所有的邏輯 14.strings.xml中使用%1$s實(shí)現(xiàn)字符串的通配 15.如果多個(gè)Activity中包含共同的UI處理，那么可以提煉一個(gè)CommonActivity，把通用部分叫由它來(lái)處理，其他activity只要繼承它即可 16.使用button+activitgroup實(shí)現(xiàn)tab效果時(shí)，使用Button.setSelected(true)，確保按鈕處于選擇狀態(tài)，并使activitygroup的當(dāng)前activity與該button對(duì)應(yīng) 17.如果所開發(fā)的為通用組件，為避免沖突，將drawable/layout/menu/values目錄下的文件名增加前綴 18.數(shù)據(jù)一定要效驗(yàn)，例如 字符型轉(zhuǎn)數(shù)字型，如果轉(zhuǎn)換失敗一定要有缺省值； 服務(wù)端響應(yīng)數(shù)據(jù)是否有效判斷