作為一個(gè)很重度的強(qiáng)迫癥患者击碗,寫代碼的時(shí)候經(jīng)常會(huì)為文件命名糾結(jié)一會(huì)兒杆煞,為了解決這個(gè)問題同時(shí)也使得項(xiàng)目看起來(lái)更加有條例谋逻,出BUG的或者找文件的時(shí)候不會(huì)一團(tuán)亂麻塔插,在網(wǎng)上找了一些文章,各種Copy自己整理了一下糯崎。
先分享這幾篇文章:
- http://blog.csdn.net/crazy1235/article/details/51346027
- http://blog.tinyx.cc/android-naming.html
- 阿里技術(shù)下載的 Java 開發(fā)手冊(cè)
幾種命名法
駝峰命名法:又稱小駝峰命名法几缭。除了首個(gè)單詞首字母小寫除外,其余所有單詞所有首字母都要大寫沃呢。
帕斯卡命名法:又稱大駝峰命名法年栓。所有單詞首字母大寫。
下劃線命名法:單詞與單詞間用下劃線做間隔樟插。
JAVA In Android
包名 采用反域名命名規(guī)則韵洋,全部使用小寫字母。一級(jí)包名為地頂級(jí)域名如com黄锤,二級(jí)包名為xx(可以是公司或則個(gè)人的隨便),三級(jí)包名根據(jù)應(yīng)用進(jìn)行命名食拜,四級(jí)包名為模塊名或?qū)蛹?jí)名; 如 com.tinyx.myapp.activities;
類名 用Pascal命名法鸵熟,盡量避免縮寫,如:MyActivity负甸;縮寫是眾所周知的流强,如HTML,URL痹届;類名稱中包含單詞縮寫,則單詞縮寫的每個(gè)字母均應(yīng)大寫打月,如:PublicHTML队腐,CommonURL。
方法名 動(dòng)詞或動(dòng)名詞
- 初始化相關(guān)方法奏篙,使用init為前綴標(biāo)識(shí)柴淘,如:初始化布局initView();
- boolean型使用is或check為前綴標(biāo)識(shí), 如:checkValue()秘通、isValidate();
- 返回某個(gè)值的方法为严,使用get為前綴標(biāo)識(shí),如:getName();
- 數(shù)據(jù)進(jìn)行處理相關(guān)肺稀,盡量使用process為前綴標(biāo)識(shí)第股,如:processUpdate();
- 保存數(shù)據(jù)相關(guān),使用save為前綴標(biāo)識(shí)话原,如:saveData();
- 對(duì)數(shù)據(jù)重置的夕吻,使用reset前綴標(biāo)識(shí),如:resetData();
- 清除數(shù)據(jù)相關(guān)繁仁,使用clear前綴標(biāo)識(shí)涉馅,如:clearData();
- 移除某些項(xiàng)目,使用remove前綴標(biāo)識(shí)改备,如:removeItem();
- 繪制數(shù)據(jù)或效果相關(guān)的控漠,使用draw前綴標(biāo)識(shí),如:drawCircle();
- 變量 采用帕斯卡命名法悬钳,建議采用有意義的命名 簡(jiǎn)單易懂
- 模型類變量 帕斯卡命名法
- 非模型類全局參數(shù)建議加上小寫m開頭 (Activity/Fragment 中的變量)
- 常量 全部大寫,采用下劃線命名法( MAX_COUNT)
- 空間變量 建議采用 控件縮寫 + 控件邏輯名稱 例:btnLogin
資源文件(Res)
遵循一個(gè)基本原則 是什么 - 在哪里會(huì)被使用 - 用來(lái)干什么 - 其他說(shuō)明
- drawable
圖標(biāo)類 如:ic_login_logo
圖片類(背景圖) 如: bg_splash
selector 如:selector_login_btn
狀態(tài)類 如:bg_login_btn_pressed
- layout
Activity 和 Fragment 省略
局部布局View文件 如:view_main_header
列表項(xiàng)(list) 如:fragment_user_list_item
自定義對(duì)話框 如:dialog_alert
anim 在哪里 -- 變化的控件 -- 動(dòng)畫 -- 方向 如:main_button_fade_in
menu 通常一個(gè)頁(yè)面不會(huì)有多個(gè)menu 所以就直接寫Activity 或者 Fragmen 名稱 如:main_activity / user_fragment
values 在哪里 -- 是什么
dimens 下劃線命名法 activity_vertical_padding huge_textsize
strings 下劃線命名法
styles 下劃線命名法
colors 駝峰命名法
attrs 駝峰命名法
控件名稱 | 縮寫 | 控件名稱 | 縮寫 |
---|---|---|---|
TextView | tv | Button | btn |
ImageButton | img | CheckBox | cb_sex |
RadioButton | rbtn | EditText | et |
RadioButton | rbtn | WebView | wv |
ToggleButton | toggle | ProgressBar | pb |
ScrollView | sv | ListView/RecyclerView | lv |
控件的命名
控件命名 : 通常是 控件縮寫_ 在哪里_干什么的(語(yǔ)意) 例: tv_main_title\ btn_user_add
控件名稱 | 縮寫 | 控件名稱 | 縮寫 |
---|---|---|---|
TextView | tv | Button | btn |
ImageButton | img | CheckBox | cb_sex |
RadioButton | rbtn | EditText | et |
RadioButton | rbtn | WebView | wv |
ToggleButton | toggle | ProgressBar | pb |
ScrollView | sv | ListView/RecyclerView | lv |
其他補(bǔ)充
- 使用Strings / dimen / colors / 盡量不要在代碼中出現(xiàn) 中文 字體大小 顏色等東西
- 不要在布局文件中添加點(diǎn)擊事件
- if / for / while / switch / do 等保留字與括號(hào)之間要加一個(gè)空格
- 任何二目盐捷、三木運(yùn)算符的左右兩邊都要加空格
- 未完待續(xù)。默勾。碉渡。