Android 命名規范 (提高代碼可以讀性)
剛 接觸android的時候,命名都是按照拼音來,所以有的時候想看懂命名的那個控件什么是什么用的,就要讀一遍甚至好幾遍才知道,這樣的話,在代碼的審查 和修改過程中就會浪費不少不必要的時間。如果就是我一個人開發,一個人維護的話還好,可是如果一個項目是團隊分工合作,這樣讓你的同事去看你的代碼就更加 吃力了,因為大家之間的編程方式不一樣,所以,在開發過程中,命名規范統一尤為重要,最好是團隊中統一好大家命名方法,這樣對于日后的工作會輕松很多。
在面試的時候,審核一個程序員的編程水平的時候,命名規范也是一大標準,所以,下面我就總結下我從網上別人的經驗和自己的感悟中收集總結的android命名規范,希望對大家有所幫助。
提醒:在命名規范的統一下,在加上注釋,這樣日后維護會高效快捷好多。
先初略介紹下當前主要的標識符命名法和英文縮寫規則:(這段別人那邊借鑒的)
在講解命名規范前,先初略介紹下當前主要的標識符命名法和英文縮寫規則。
標識符命名法
標識符命名法最要有四種:
1 駝峰(Camel)命名法:又稱小駝峰命名法,除首單詞外,其余所有單詞的第一個字母大寫。
2 帕斯卡(pascal)命名法:又稱大駝峰命名法,所有單詞的第一個字母大寫
3 下劃線命名法:單詞與單詞間用下劃線做間隔。
4 匈牙利命名法:廣泛應用于微軟編程環境中,在以Pascal命名法的變量前附加小寫序列說明該變量的類型。 量的取名方式為:<scope_> + <prefix_> + <qualifier>范圍前綴,類型前綴,限定詞。
個人覺得標識符命名原則:盡可能的用最少的字符而又能完整的表達標識符的含義。
英文縮寫原則:
1 較短的單詞可通過去掉“元音”形成縮寫
2 較長的單詞可取單詞的頭幾個字母形成縮寫
3 此外還有一些約定成俗的英文單詞縮寫.
下面為常見的英文單詞縮寫:
名稱 |
縮寫 | |
icon |
ic (主要用在app的圖標) |
|
color |
cl(主要用于顏色值) |
|
divider |
di(主要用于分隔線,不僅包括Listview中的divider,還包括普通布局中的線) |
|
selector |
sl(主要用于某一view多種狀態,不僅包括Listview中的selector,還包括按鈕的selector) |
|
average |
avg |
|
background |
Bg(主要用于布局和子布局的背景) |
|
buffer |
buf |
|
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) |
包名 |
此包中包含 | |
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服務 |
類 |
描述 | 例如 |
activity 類 |
Aty或者Activity為后綴標識 |
歡迎頁面類WelcomeAty.或者WelcomeActivity |
Adapter類 |
Adp或者Adapte 為后綴標識 |
新聞詳情適配器NewtDetailAdp或則直接 NewDetailAdapter |
解析類 |
Hlr為后綴標識 |
首頁解析類HomePosterHlr |
公共方法類 |
Tools或Manager為后綴標識 |
線程池管理類:ThreadPoolManager |
數據庫類 |
以DBHelper后綴標識 |
新聞數據庫:NewDBHelper |
Service類 |
以Service為后綴標識 |
時間服務TimeService |
BroadcastReceive類 |
以Broadcast為后綴標識 |
時間通知TimeBroadcast |
ContentProvider |
以Provider為后綴標識 |
|
直接寫的共享基礎類 |
以Base開頭 |
BaseActivity,BaseFragment |
方法 |
說明 | |
initXX() |
初始化相關方法,使用init為前綴標識,如初始化布局initView() |
|
isXX() |
checkXX()方法返回值為boolean型的請使用is或check為前綴標識 |
|
getXX() |
返回某個值的方法,使用get為前綴標識 |
|
processXX() |
對數據進行處理的方法,盡量使用process為前綴標識 |
|
displayXX() |
彈出提示框和提示信息,使用display為前綴標識 |
|
saveXX() |
與保存數據相關的,使用sav為e前綴標識 |
|
resetXX() |
對數據重組的,使用reset前綴標識 |
|
clearXX() |
清除數據相關的 |
|
removeXXX() |
清除數據相關的 |
|
drawXXX() |
繪制數據或效果相關的,使用draw前綴標識 |
名稱 |
功能 | |
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沒有被選中 |
動畫命名例子 |
規范寫法 | 備注 |
fade_in |
淡入 |
|
fade_out |
淡出 |
|
push_down_in |
從下方推入 |
|
push_down_out |
從下方推出 |
|
push_left |
推像左方 |
|
slide_in_from_top |
從頭部滑動進入 |
|
zoom_enter |
變形進入 |
|
slide_in |
滑動進入 |
|
shrink_to_middle |
中間縮小 |
|
控件 |
縮寫 |
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 |