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) |
程式中使用單詞縮寫原則:不要用縮寫,除非該縮寫是約定俗成的。
命名規範:
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 |
資料庫類 |
以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字首標識 |
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 |
12.activity中的view變數命名
命名模式為:邏輯名稱+view縮寫
建議:如果layout檔案很複雜,建議將layout分成多個模組,每個模組定義一個moduleViewHolder,其成員變數包含所屬view
13.styles.xml:將layout中不斷重現的style提煉出通用的style通用元件,放到styles.xml中;
14.使用layer-list和selector
Android編碼規範建議(別人弄的覺得蠻有道理)
1.java程式碼中不出現中文,最多註釋中可以出現中文
2.區域性變數命名、靜態成員變數命名
只能包含字母,單詞首字母除第一個外,都為大寫,其他字母都為小寫
3.常量命名
只能包含字母和_,字母全部大寫,單詞之間用_隔開
4.圖片儘量分拆成多個可重用的圖片
5.服務端可以實現的,就不要放在客戶端
6.引用第三方庫要慎重,避免應用大容量的第三方庫,導致客戶端包非常大
7.處理應用全域性異常和錯誤,將錯誤以郵件的形式傳送給服務端
8.圖片的.9處理
9.使用靜態變數方式實現介面間共享要慎重
10.Log(系統名稱模組名稱介面名稱,詳細描述)
11.單元測試(邏輯測試、介面測試)
12.不要重用父類的handler,對應一個類的handler也不應該讓其子類用到,否則會導致message.what衝突
13.activity中在一個View.OnClickListener中處理所有的邏輯
14.strings.xml中使用%1$s實現字串的通配
15.如果多個Activity中包含共同的UI處理,那麼可以提煉一個CommonActivity,把通用部分叫由它來處理,其他activity只要繼承它即可
16.使用button+activitgroup實現tab效果時,使用Button.setSelected(true),確保按鈕處於選擇狀態,並使activitygroup的當前activity與該button對應
17.如果所開發的為通用元件,為避免衝突,將drawable/layout/menu/values目錄下的檔名增加字首
18.資料一定要效驗,例如
字元型轉數字型,如果轉換失敗一定要有預設值;
服務端響應資料是否有效判斷
相關文章
- Android 程式碼規範 - 命名規範Android
- Android程式碼規範:命名規範Android
- Android命名規範Android
- android檔案命名規範Android
- 用BEM命名規範組織CSS程式碼CSS
- Android 程式碼規範大全Android
- C#程式碼識別符號命名規範C#符號
- 統一規範化程式碼的命名風格
- 17joys專案程式碼的命名規範
- iOS程式碼規範之駝峰命名法camelCaseiOS
- Android應用版本命名規範Android
- 前端工程程式碼規範(一)——命名規則與工程約定前端
- 【iOS 搭建基礎框架】編碼規範 (命名規範篇)iOS框架
- PHP 命名規範PHP
- JavaScript 命名規範JavaScript
- PHP命名規範PHP
- CSS命名規範CSS
- SqlServer命名規範SQLServer
- Google命名規範Go
- java命名規範Java
- 阿里Android開發規範:資原始檔命名與使用規範阿里Android
- C#程式設計命名規範C#程式設計
- 程式設計命名規範(網文)程式設計
- 前端開發規範:命名規範、html規範、css規範、js規範前端HTMLCSSJS
- 『前端規範化』CSS命名規範化前端CSS
- Python程式碼規範性檢測Python
- Python命名規範Python
- CSS — BEM 命名規範CSS
- 前端命名基本規範前端
- css 命名規範 BEMCSS
- C#命名規範C#
- 為元組中的每個元素命名,提高程式可讀性
- Android程式碼的書寫規範Android
- Android程式碼規範參考指南Android
- PHP 規範 - Symfony 程式碼規範PHP
- C++編碼命名規範 -- 目前應用C++
- Oracle 資料庫管理指令碼命名規範Oracle資料庫指令碼
- 最佳實踐之 Android程式碼規範Android