Android開發命名規范,有它就夠了

還記得剛開始coding的時候,命名都是漢語拼音,所以有的時候想看懂它的意思,就要讀一遍甚至好幾遍才知道,這還是在你小學拼音過關的基礎上。這樣的話,在代碼的審查和修改過程中就會浪費不少不必要的時間。如果你是獨立開發還好,可是如果是團隊分工合作,這樣讓你的同事去看你的代碼就更加吃力了,因為大家之間的編程方式不一樣,所以,在開發過程中,命名規范統一尤為重要,最好是團隊中統一好大家命名方法,這樣對于日后的工作會輕松很多。

命名規范作為編碼一大標準,往小了說,可以反映一個程序員的代碼潔癖,往大了說可能間接影響到你的職業生涯的高度(注意這里絕逼不是危言聳聽)。所以,本文就從Android的角度來談談代碼的命名規范,希望對大家有所幫助。

良好的編碼規范是不可能缺少注釋的,注釋是軟件可讀性的具體體現。程序注釋量一般占程序編碼量的20%,軟件工程要求不少于20%。其內容主要是函數的功能、目的、算法等說明,參數說明、返回值說明等。其中公用函數、公用類的聲明必須由注解說明其使用方法和設計思路,當然選擇恰當的命名格式能夠幫助你把事情解釋得更清楚。當然了,注釋一般包括類注釋方法注釋變量注釋

我覺得這里在講解命名規范前,有必要先粗略介紹下當前主要的標識符命名法和英文縮寫規則。

標識符命名法

標識符命名法主要有四種:

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

2帕斯卡(pascal)命名法:又稱大駝峰命名法,所有單詞的第一個字母大寫

3下劃線命名法:單詞與單詞間用下劃線做間隔。

4匈牙利命名法:廣泛應用于微軟編程環境中,在以Pascal命名法的變量前附加小寫序列說明該變量的類型。 量的取名方式為: + + 范圍前綴,類型前綴,限定詞。

注意這里標識符命名有個不成文的原則:盡可能的用最少的字符而又能完整的表達標識符的含義。

英文縮寫原則:

1 較短的單詞可通過去掉“元音”形成縮寫

2 較長的單詞可取單詞的頭幾個字母形成縮寫

3 此外還有一些約定成俗的英文單詞縮寫.

下面為常見的英文單詞縮寫:


常見英文單詞縮寫

程序中使用單詞縮寫原則:盡量不要用縮寫,除非該縮寫是約定俗成的。

命名規范:

1(packages): 采用反域名命名規則,全部使用小寫字母。一級包名為com,二級包名為xx(可以是公司或則個人的隨便),三級包名根據應用進行命名(如myapp),四級包名為模塊名或層級名


包名命名規范

2(classes):名詞,采用大駝峰命名法,盡量避免縮寫,除非該縮寫是眾所周知的, ?比如HTML,URL,如果類名稱中包含單詞縮寫,則單詞縮寫的每個字母均應大寫。


類名命名規范

3接口(interface):命名規則與類一樣采用大駝峰命名法,多以大寫的I(interface縮寫)開頭或者able或ible結尾,如interface Runnable ;interface Accessible 。

4方法(methods):動詞或動名詞,采用小駝峰命名法例如:onCreate(),run()


方法命名規范

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)


命名后綴:


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

3).PopupWindow命名:ppw_描述.xml

例如:ppw _info.xml

4). 列表項命名listitem_描述.xml

例如:listitem_city.xml

5).包含項:include_模塊.xml

例如:include_head.xml、include_bottom.xml

6).adapter的子布局:功能模塊_item.xml

例如:main_item.xml、

9動畫文件(anim文件夾下):全部小寫,采用下劃線命名法,加前綴區分。

//前面為動畫的類型,后面為方向


10資源ID(resourcesid):大小寫規范與方法名一致,采用小駝峰命名法。命名規范為“資源控件的縮寫 ?名”+“變量名”。注意:頁面控件名稱應該和控件id名保持一致strings.xml,colors.xml等中的id命名:

命名模式:activity名稱_功能模塊名稱_邏輯名稱/activity名稱_邏輯名稱/common_邏輯名稱strings.xml中,使用activity名稱注釋,將文件內容區分開來

11layout中控件視圖的id命名

命名模式為:view縮寫_模塊名稱_view的邏輯名稱

view的縮寫詳情如下:


12activity中的view變量命名

命名模式為:邏輯名稱+view縮寫

建議:如果layout文件很復雜,建議將layout分成多個模塊,每個模塊定義一個moduleViewHolder,其成員變量包含所屬view

13styles.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.數據一定要效驗,例如字符型轉數字型,如果轉換失敗一定要有缺省值;

以上分門別類的列舉了你在Android開發中經常會用到的一些“命名規范”,之所以打上引號,就是說這些所謂的規范并不是說你不這樣用程序就跑不起來,不違法也不有悖于道德,但是這些都是業內前輩們留下來的精神文明產物,所以在你有更好的解決辦法之前,請先繼承起來吧,畢竟我們的目標就是:擼得一手漂亮簡潔高效的代碼!



掃碼進行關注
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念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

推薦閱讀更多精彩內容