【轉載】android命名規范

無論是哪種編程語言的學習,我們的命名都要有一定的規范才能更好的進行團隊協作,更好的進行代碼的的二次開發。所以在這里轉載了這篇文章,希望自己以后的代碼能夠規范,也希望大家的代碼能夠命名規范,而且沒有bug~
標識符命名法
標識符命名法最要有四種:

1. 駝峰(Camel)命名法:

又稱小駝峰命名法,除首單詞外,其余所有單詞的第一個字母大寫。

2. 帕斯卡(pascal)命名法:

又稱大駝峰命名法,所有單詞的第一個字母大寫

3. 下劃線命名法:單詞與單詞間用下劃線做間隔。個人覺得標識符命名原則:**盡可能的用最少的字符而又能完整的表達標識符的含義。

**英文縮寫原則: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為后綴標識| 歡迎頁面類WelcomeActivity
|Adapter類|Adp或者Adapte 為后綴標識|新聞詳情適配器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 Runnable;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 圖片的狀態,代表普通狀態
圖片的狀態,代表高亮狀態
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 iBtn
ImageView imgView 或則 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 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. 數據一定要效驗,例如
    字符型轉數字型,如果轉換失敗一定要有缺省值;
    服務端響應數據是否有效判斷

最后,我想說,命名規范不要去局限于這些規則,要記住規范的核心就是簡單而且便于理解,所以說多種命名規范只要能夠有利于自己的學習,就ok了、
附上相應的規范文檔
Google Java編程風格規范
Google C++ 風格指南
Google Objective-C 風格指南
Python 風格指南
Shell 風格指南

我是勤勞的搬運工。原文地址 http://gold.xitu.io/entry/566397c900b01b7852d35c03

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,119評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,382評論 3 415
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,038評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,853評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,616評論 6 408
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,112評論 1 323
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,192評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,355評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,869評論 1 334
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,727評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,928評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,467評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,165評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,570評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,813評論 1 282
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,585評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,892評論 2 372

推薦閱讀更多精彩內容