Android命名規範

程序的命名規範尤爲重要,通過一個程序員所寫程序的命名方式上,可以看出一個程序員水平的高低,一個規範的命名,可以增加代碼的可讀性,這對於團隊協作開發中更爲重要,最好是團隊中統一好大家命名方法,這樣對於日後的工作會輕鬆很多。

下面總結幾點常用的命名規範

1  包(packages): 採用反域名命名規則,全部使用小寫字母。一級包名爲com,二級包名爲xx(可以是公司或則個人的隨便),三級包名根據應用進行命名,四級包名爲模塊名或層級名


2  類(classes):名詞,採用大駝峯命名法所有單詞的第一個字母大寫,儘量避免縮寫,除非該縮寫是衆所周知的,  比如HTML,URL,如果類名稱中包含單詞縮寫,則單詞縮寫的每個字母均應大寫。


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前綴標識



5  變量(variables)採用小駝峯命名法。類中控件名稱必須與xml佈局id保持一致。

用統一的量詞通過在結尾處放置一個量詞,就可創建更加統一的變量,它們更容易理解,也更容易搜索。例如,請使用strCustomerFirst和strCustomerLast,而不要使用strFirstCustomer和strLastCustomer。
量詞列表:量詞後綴說明
First  一組變量中的第一個
Last   一組變量中的最後一個
Next   一組變量中的下一個變量
Prev   一組變量中的上一個
Cur    一組變量中的當前變量
 
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

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 






























控件

縮寫

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中;

14.使用layer-list和selector

15.android多國語言文件夾文件彙總如下:

維吾爾文(中國):values-ug-rCN

中文(中國):values-zh-rCN

中文(臺灣):values-zh-rTW

中文(香港):values-zh-rHK

英語(美國):values-en-rUS

英語(英國):values-en-rGB

英文(澳大利亞):values-en-rAU

英文(加拿大):values-en-rCA

英文(愛爾蘭):values-en-rIE

英文(印度):values-en-rIN

英文(新西蘭):values-en-rNZ

英文(新加坡):values-en-rSG

英文(南非):values-en-rZA

阿拉伯文(埃及):values-ar-rEG

阿拉伯文(以色列):values-ar-rIL

保加利亞文:  values-bg-rBG

加泰羅尼亞文:values-ca-rES

捷克文:values-cs-rCZ

丹麥文:values-da-rDK

德文(奧地利):values-de-rAT

德文(瑞士):values-de-rCH

德文(德國):values-de-rDE

德文(列支敦士登):values-de-rLI

希臘文:values-el-rGR

西班牙文(西班牙):values-es-rES

西班牙文(美國):values-es-rUS

芬蘭文(芬蘭):values-fi-rFI

法文(比利時):values-fr-rBE

法文(加拿大):values-fr-rCA

法文(瑞士):values-fr-rCH

法文(法國):values-fr-rFR

希伯來文:values-iw-rIL

印地文:values-hi-rIN

克羅里亞文:values-hr-rHR

匈牙利文:values-hu-rHU

印度尼西亞文:values-in-rID

意大利文(瑞士):values-it-rCH

意大利文(意大利):values-it-rIT

日文:values-ja-rJP

韓文:values-ko-rKR

立陶宛文:valueslt-rLT

拉脫維亞文:values-lv-rLV

挪威博克馬爾文:values-nb-rNO

荷蘭文(比利時):values-nl-BE

荷蘭文(荷蘭):values-nl-rNL

波蘭文:values-pl-rPL

葡萄牙文(巴西):values-pt-rBR

葡萄牙文(葡萄牙):values-pt-rPT

羅馬尼亞文:values-ro-rRO

俄文:values-ru-rRU

斯洛伐克文:values-sk-rSK

斯洛文尼亞文:values-sl-rSI

塞爾維亞文:values-sr-rRS

瑞典文:values-sv-rSE

泰文:values-th-rTH

塔加洛語:values-tl-rPH

土耳其文:values–r-rTR

烏克蘭文:values-uk-rUA

越南文:values-vi-rVN



控件

縮寫

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

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章