Android教程網 >> Android技術 >> 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
日志工具類：LogTools

數據庫類
以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