命名規範

 

一)  Layout命名

1．contentview命名：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

 

(二)  圖片命名

1.       靜態圖片前綴_模塊、前綴_模塊_描述

例如：bg_main.png、ic_main_search.png

2.       動態圖片前綴_模塊_描述_狀態、前綴_描述_狀態

              例如：btn_film_buy_n.png、btn_film_buy_p.png、btn_back_n.png

       若是有多種形態如按鈕等除外如btn_film_buy.xml（selector）

 

  我的習慣使用：android:id="@id/tvName"android:id="@id/listvName"、android:id="@id/tvHeadTitle",而後在class裏的命名和id名字保持一致

(四)  字符串命名

       最好不要跟title、dialog、button等東西關係起來，直接用相同英文含義就能夠了，若是下：

<string name="ok">肯定</string>

<string name=" welcome_to_use">歡迎使用</string>

 

再舉一些很差的例子，以下<string name="menu_ok ">肯定</string>

 

(五)  控件命名

控件縮寫_描述

例如：TextViewtv_name、Button btn_buy、LinearLayoutllyt_body;

 

(六)  類命名

功能模塊Activity.class  功能模塊Service.class

如：MainActivity.class  HuaFuBaoActivity.classAppUpgradeService.class

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

包名   
此包中包含
com.xx.應用名稱縮寫.activities
   
頁面用到的Activity類 (activities層級名用戶界面層)
com.xx.應用名稱縮寫.base
     頁面中每一個Activity類共享的能夠寫成一個i額BaseActivity類 (基礎共享的類)

com.xx.應用名稱縮寫.adapter 
    頁面用到的Adapter類 (適配器的類)

com.xx.應用名稱縮寫.tools
    此包中包含：公共工具方法類（tools模塊名）

com.xx.應用名稱縮寫.bean
    (或則 com.xx.應用名稱縮寫.unity )
    此包中包含：元素類

com.xx.應用名稱縮寫.db   
    數據庫操做類

com.xx.應用名稱縮寫.view

    (或則 com.xx.應用名稱縮寫.ui )   
     自定義的View類等

com.xx.應用名稱縮寫.service   
    Service服務

com.xx.應用名稱縮寫.broadcast     
    Broadcast服務
2  類（classes）：名詞，採用大駝峯命名法，儘可能避免縮寫，除非該縮寫是衆所周知的，  好比HTML,URL，若是類名稱中包含單詞縮寫，則單詞縮寫的每一個字母均應大寫。   
描述   
例如
activity 類   
     Aty或者Activity爲後綴標識
     歡迎頁面類WelcomeAty.或者WelcomeActivity

Adapter類   
     Adp或者Adapte 爲後綴標識   
     新聞詳情適配器NewtDetailAdp或則直接  NewDetailAdapter

解析類
     Hlr爲後綴標識
       首頁解析類HomePosterHlr
 
公共方法類
    Tools或Manager爲後綴標識
   

線程池管理類：ThreadPoolManager
        日誌工具類：LogTools

數據庫類
    以DBHelper後綴標識
   
新聞數據庫：NewDBHelper

    Service類
    以Service爲後綴標識   
    時間服務TimeService

BroadcastReceive類:以Broadcast爲後綴標識時間通知TimeBroadcast
ContentProvider:以Provider爲後綴標識
 
直接寫的共享基礎類: 以Base開頭 BaseActivity,BaseFragment

3  接口（interface）：命名規則與類同樣採用大駝峯命名法，多以able或ible結尾，如interface Runna ble ;
                     interface Accessible 。

4  方法（methods）：動詞或動名詞，採用小駝峯命名法例如:onCreate(),run()

initXX():初始化相關方法,使用init爲前綴標識，如初始化佈局initView()

isXX(): checkXX()方法返回值爲boolean型的請使用is或check爲前綴標識

getXX(): 返回某個值的方法，使用get爲前綴標識

processXX() :對數據進行處理的方法，儘可能使用process爲前綴標識

displayXX(): 彈出提示框和提示信息，使用display爲前綴標識

saveXX():與保存數據相關的，使用sav爲e前綴標識

resetXX():對數據重組的，使用reset前綴標識

clearXX():清除數據相關的

removeXXX() :清除數據相關的

drawXXX():繪製數據或效果相關的，使用draw前綴標識

 

6  常量（Constants）所有大寫,採用下劃線命名法.例如：MIN_WIDTH

7  資源文件（圖片drawable文件夾下）：所有小寫，採用下劃線命名法，加前綴區分

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

若是有多種形態如按鈕等除外如btn_xx.xml（selector）

名稱_功能

btn_xx :按鈕圖片使用btn_總體效果（selector）

btn_xx_normal :按鈕圖片使用btn_正常狀況效果

btn_xx_press: 按鈕圖片使用btn_點擊時候效果

bg_head:背景圖片使用bg_功能_說明

def_search_cell: 默認圖片使用def_功能_說明

icon_more_help:圖標圖片使用icon_功能_說明

seg_list_line:具備分隔特徵的圖片使用seg_功能_說明

sel_ok:選擇圖標使用sel_功能_說明

命名後綴：
後綴說明
unit:在使用xml的tilemode來配圖片時，element圖片使用此後綴
nor:圖片的狀態，表明普通狀態
hl:圖片的狀態，表明高亮狀態
press:圖片的狀態，表明按下狀態
select:圖片的狀態，表明其所佔的view被選中
unselect:圖片的狀態，表明其所佔的view沒有被選中

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文件夾下）：所有小寫，採用下劃線命名法，加前綴區分。
//前面爲動畫的類型，後面爲方向
動畫命名例子   
規範寫法    備註

fade_in : 淡入
fade_out :淡出   
push_down_in:從下方推入
push_down_out:從下方推出
push_left:推像左方
slide_in_from_top:從頭部滑動進入
zoom_enter:變形進入
slide_in:滑動進入
shrink_to_middle:中間縮小

10    資源ID（resourcesid）：大小寫規範與方法名一致，採用小駝峯命名法。命名規範爲「資源控件的縮寫  名」+「變量名」。注意：頁面控件名稱應該和控件id名保持一致
strings.xml，colors.xml等中的id命名：
命名模式：activity名稱_功能模塊名稱_邏輯名稱/activity名稱_邏輯名稱/common_邏輯名稱
strings.xml中，使用activity名稱註釋，將文件內容區分開來
11   layout中的id命名
命名模式爲：view縮寫_模塊名稱_view的邏輯名稱
view的縮寫詳情以下：

控件 縮寫

LayoutView     lv
RelativeView    rv
TextView     tv
Button        btn
ImageButton     imgBtn
ImageView    mgView 或則 iv
CheckBox    chk
RadioButton    rdoBtn
analogClock        anaClk
DigtalClock        dgtClk
DatePicker         dtPk
EditText           edtTxt
TimePicker         tmPk
toggleButton       tglBtn
ProgressBar proBar
SeekBar                            skBar
AutoCompleteTextView    autoTxt
ZoomControls       zmCtl
VideoView         vdoVi
WdbView            webVi
RantingBar         ratBar
Tab                tab
Spinner                spn
Chronometer       cmt
ScollView          sclVi
TextSwitch         txtSwt
ImageSwitch            imgSwt
listView               lVi 或則lv
ExpandableList         epdLt
MapView                mapVi

12.activity中的view變量命名

命名模式爲：邏輯名稱+view縮寫

建議：若是layout文件很複雜，建議將layout分紅多個模塊，每一個模塊定義一個moduleViewHolder，其成員變量包含所屬view

13.styles.xml：將layout中不斷重現的style提煉出通用的style通用組件，放到styles.xml中；