原文鏈接http://www.apkbus.com/blog-705730-62684.html
命名規範要望文知義,簡單明瞭。
命名規範定製太多,就會讓人心煩,反而沒人遵守了。
---《APP研發錄》
命名沒有具體的要求,只能說跟上面的要求滿足就夠了,目前網上能夠搜到各種風格的方案,選擇一種自己之前沒有章法的時候就下意識接近了的,或者自己喜歡的能夠快速記住的方案,堅持一兩個Demo,大概就能基本記住了。
方案來源於網絡,修改添加了部分自己用的習慣。這裏整理記錄一下本人將默認採用,並且將統一到開發中的方案。
忘了就翻出來瞅瞅!!
命名規範
- 包命名,單詞全部小寫
域名反寫+項目名稱+模塊名稱,例如:
activity包: cf.paradoxie.demo.activity
實體包: cf.paradoxie.demo.bean
工具包: cf.paradoxie.demo.utils
- 接口和類命名,單詞首字母大寫(大駝峯規則)
以下爲幾種常用類的命名:
公共父類,命名以Base開頭,如:BaseActivity, BaseAdapter
activity類,命名以Activity爲後綴,如:LoginActivity
fragment類,命名以Fragment爲後綴,如:LoginFragment
service類,命名以Service爲後綴,如:DownloadService
adapter類,命名以Adapter爲後綴,如:MyListAdapter
工具類,命名以Util爲後綴,如:StringUtil
接口類,命名以I爲前綴(來源於MVP模式),如:IUser
接口實現類,命名以Impl爲後綴,如:UserImpl
- 方法命名,除開第一個單詞首字母,其餘都大寫(小駝峯規則)
以下爲幾種常用方法的命名:
初始化方法,命名以init開頭,例:initView
設置方法,命名以set開頭,例:setData
儲存方法,命名以save開頭,例:saveData
具有返回值的獲取方法,命名以get開頭,例:getData
通過異步加載數據的方法,命名以load開頭,例:loadData
布爾型的判斷方法,命名以is或has,或具有邏輯意義的單詞如equals,例:isEmpty
- 常用控件id命名縮寫
控件 | 命名 | 控件 | 命名 | |
---|---|---|---|---|
TextView | tv | RadioGroup | group | |
EditText | et | RadioButton | rbtn | |
Button | btn | ProgressBar | progress | |
ImageView | iv | CheckBox | cb | |
ImageButton | ibtn | Spinner | spinner | |
ListView | lv | ScrollView | sv | |
LinearLayout | ll | RelativeLayout | rl | |
FramLayout | fl | TableLayout | tl |
以上縮寫爲代表控件的縮寫,其id全稱需根據配合所在佈局及其功能意義而定,縮寫_{範圍_}意義,例如:
登錄按鈕:btn_login;
相對佈局的tab欄:rl_tab;
標題欄文本:tv_head_title
- 佈局 layout命名
類型_{範圍_}功能,範圍可選,只在有明確定義的範圍內才需要加上。
以下爲幾種常用的組件類型命名:
activity_{範圍_}功能,爲Activity的命名格式:activity_login
fragment_{範圍_}功能,爲Fragment的命名格式
dialog_{範圍_}功能,爲Dialog的命名格式
headerlist\{範圍_}功能,爲ListView的HeaderView命名格式
footerlist\{範圍_}功能,爲ListView的FooterView命名格式
- strings的命名
類型_{範圍_}功能,範圍可選。
以下爲幾種常用的命名:
頁面標題,命名格式爲:title_頁面
按鈕文字,命名格式爲:btn_按鈕事件
標籤文字,命名格式爲:label_標籤文字
選項卡文字,命名格式爲:tab_選項卡文字
消息框文字,命名格式爲:toast_消息
編輯框的提示文字,命名格式爲:hint_提示信息
圖片的描述文字,命名格式爲:desc_圖片文字
對話框的文字,命名格式爲:dialog_文字
menu的item文字,命名格式爲:action_文字
- colors的命名
前綴{_控件}{_範圍}{_後綴},控件、範圍、後綴可選,但控件和範圍至少要有一個:
背景顏色,添加bg前綴
文本顏色,添加text前綴
分割線顏色,添加div前綴
區分狀態時,默認狀態的顏色,添加normal後綴
區分狀態時,按下時的顏色,添加pressed後綴
區分狀態時,選中時的顏色,添加selected後綴
區分狀態時,不可用時的顏色,添加disable後綴
- drawable的命名
跟以上colors的命名類似,此處多了選擇器
添加selector後綴(一般爲ListView的selector或按鈕的selector)
- 動畫文件命名
動畫類型_動畫方向
fade_in,淡入
fade_out,淡出
push_down_in,從下方推入
push_down_out,從下方推出
slide_in_from_top,從頭部滑動進入
zoom_enter,變形進入
shrink_to_middle,中間縮小
- 變量命名
只能包含字母,單詞首字母除第一個外,都爲大寫,其他字母都爲小寫
普通變量:mXyxy,或userBean
控件變量,類型爲前綴,功能在後面:btnLogin
- 常量命名
全部大寫,採用下劃線命名法.例如:MAX_VALUE
|