Android --- 命名规范
一、命名規(guī)范
1、 包
采用反域名命名規(guī)則，全部使用小寫字母。一級(jí)包名為com，二級(jí)包名xxx（為個(gè)人或公司名稱，可以簡寫），三級(jí)包名根據(jù)應(yīng)用進(jìn)行命名，四級(jí)包名utils或service等（模塊名或?qū)蛹?jí)名），根據(jù)實(shí)際情況也是可以用五級(jí)包名，六級(jí)包名。
????????utils
?????????此包中包含：公共工具方法類，比如：LogUtil、TimeUitl、FileUtil等
? ? ? ? adapter
?????????此包中包含一些適配器的類，比如：CardAdapter、FloatWindowAdapter等
? ? ? ? base
?????????此包中包含：一些共同類的基類，比如：BaseActivity（所有的Activity類都繼承這個(gè)類）、BaseFragment（所有的Fragment都繼承這個(gè)類）
? ? ? ? bean
?????????此包中包含：一些屬性對(duì)象類，比如：StudentBean、UserBean等
? ? ? ? config
?????????此包中包含：最頂級(jí)的配置類，比如：MyApplication（繼承了Application）
? ? ? ? httpservice
?????????此包中包含：Http數(shù)據(jù)的請(qǐng)求接口類,如：ILogin接口，IRegister，IUpdate等
? ? ? ? interface
?????????此包中包含：某個(gè)頁面或?qū)ο蟮乃貌僮鹘涌陬?#xff0c;這個(gè)接口主要是定義這個(gè)對(duì)象的所有方法。如：IUser接口，IArticle接口，ITopic接口等
? ? ? ? model
?????????這是MVC或MVP框架設(shè)計(jì)中的M。此包中包含：某個(gè)頁面或?qū)ο蟮乃貌僮黝?#xff0c;這個(gè)類繼承了上面定義的interface接口，重寫并實(shí)現(xiàn)方法。如：UserModel，lLoginMode類
? ? ? ? view
? ? ? ? 此包中包含：activity包。如MainActivity，HomeActivity.?
????????????????????????????????fragment包。但是Fragment一般都是多個(gè)存在的，所以fragment包下一般還有六級(jí)包名，表示里面是哪個(gè)頁面的Fragment對(duì)象。
? ? ? ? weight
?????????此包中包含：自定義View或自定義對(duì)話框等視圖類。如：CursroDialog類，ScrollListView類等
? ? ? ? db
?????????此包中包含：數(shù)據(jù)庫操作類
????????service
?????????此包中包含：Service服務(wù)類
????????broadcast
?????????此包中包含：Broadcast廣播接收者類
? ? ? ? provider
?????????此包中包含：Provider內(nèi)容提供者類
2、?類名首字母大寫，如果類名由多個(gè)單詞組成，每個(gè)單詞的首字母都要大寫。
如：public class MyFirstClass{}
3、?變量名、方法名首字母小寫，如果名稱由多個(gè)單詞組成，每個(gè)單詞的首字母都要大寫。
如：int index=0;
???????public void toString(){}
? ? ? ?isXX()?checkXX()方法返回值為boolean型的請(qǐng)使用is或check為前綴標(biāo)識(shí)
? ?????getXX(),返回某個(gè)值的方法，使用get為前綴標(biāo)識(shí)
4、?常量名全部大寫
private static final String DEFAULT_VALUE = null;
6、所有命名規(guī)則必須遵循以下規(guī)則：
????1)、名稱只能由字母、數(shù)字、下劃線、$符號(hào)組成
????2)、不能以數(shù)字開頭
????3)、名稱不能使用JAVA中的關(guān)鍵字。
????4)、堅(jiān)決不允許出現(xiàn)中文及拼音命名。
? ? 5)、程序中使用單詞縮寫原則：不要用縮寫，除非該縮寫是約定俗成的。
下面為常見的英文單詞縮寫:
名稱縮寫
icon ?ic?（主要用在app的圖標(biāo)）
color ?cl（主要用于顏色值）
divider????di（主要用于分隔線，不僅包括Listview中的divider，還包括普通布局中的線）
selector????sl（主要用于某一view多種狀態(tài)，不僅包括Listview中的selector，還包括按鈕的selector）sel_ok?選擇圖標(biāo)使用sel_功能_說明
average????avg
background??bg（主要用于布局和子布局的背景）
? ??????????????????bg_head?背景圖片使用bg_功能_說明
buffer????buf
control????ctrl
delete????del
document?doc
dialog? ? ? ? dlg_hint.xml
error????err
escape????esc
increment????inc
infomation? ?info
initial?init
image????img
Internationalization? ? I18N
length????len
library????lib
message????msg
password????pwd
position????pos
popupWindow? ? ppw_info.xml
server????srv
string????str
temp????tmp
window????wnd(win)
button????btn_xx?
????????????????btn_xx_normal?按鈕圖片使用btn_正常情況效果
????????????????btn_xx_press?按鈕圖片使用btn_點(diǎn)擊時(shí)候效果
LayoutView????lv
RelativeView????rv
TextView????tv
Button????btn
ImageButton????????imgBtn
ImageView? ? ? ? ?imgView?或 iv
EditText ??????????edtTxt
Tab????????????????tab
Spinner????????????spn
Chronometer????????cmt
ScollView??????????sclVi
TextSwitch?????????txtSwt
ImageSwitch????????imgSwt
listView???????????lVi?或則lv
ExpandableList?????epdLt
MapView????????????mapVi
二、注釋規(guī)范
1、類注釋
在每個(gè)類前面必須加上類注釋，注釋模板如下：
/**
* Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.
* FileName: Test.java
*?類的詳細(xì)說明
*
* @author?類創(chuàng)建者姓名
* @Date????創(chuàng)建日期
* @version 1.00
*/
2、屬性注釋
在每個(gè)屬性前面必須加上屬性注釋，注釋模板如下：
/**?提示信息 */
private String strMsg = null;
3、方法注釋
在每個(gè)方法前面必須加上方法注釋，注釋模板如下：
/**
*?類方法的詳細(xì)使用說明
*
* @param?參數(shù)1?參數(shù)1的使用說明
* @return?返回結(jié)果的說明
* @throws?異常類型.錯(cuò)誤代碼 注明從此類方法中拋出異常的說明
*/
4、構(gòu)造方法注釋
在每個(gè)構(gòu)造方法前面必須加上注釋，注釋模板如下：
/**
*?構(gòu)造方法的詳細(xì)使用說明
*
* @param?參數(shù)1?參數(shù)1的使用說明
* @throws?異常類型.錯(cuò)誤代碼 注明從此類方法中拋出異常的說明
*/
5、方法內(nèi)部注釋
在方法內(nèi)部使用單行或者多行注釋，該注釋根據(jù)實(shí)際情況添加。
如：//背景顏色
???????Color bgColor = Color.RED
總結(jié)
以上是生活随笔為你收集整理的Android --- 命名规范的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： Android --- 屏幕方向scre
- 下一篇： Android --- 新版本取色器吸管