Carson帶你學(xué)Android:你不能忽略的代碼命名規(guī)范

前言

  • Android代碼規(guī)范內(nèi)容非常多,但對我們最有用& 最有影響的莫過于 Android代碼的命名規(guī)范
  • 可是,有很多人容易忽略Android代碼的命名規(guī)范,從而導(dǎo)致代碼的可讀性 & 維護性非常差,最終導(dǎo)致開發(fā)效率 & 維護效率降低
  • 今天,我將根據(jù) Google Java 編程規(guī)范 & Google 官方 Android 編碼規(guī)范,為大家?guī)?strong>一份全面 & 清晰的Android代碼命名規(guī)范,希望你們會喜歡。

目錄

示意圖

1. 為什么 規(guī)范 Android 代碼命名?

  • 增強代碼的可讀性
  • 增強代碼的可維護性

正由于上述兩個作用,從而使得 開發(fā)效率 & 維護效率 得到大幅度的提高。


2. Android需要命名的代碼(對象)有哪些?

示意圖

3. 具體命名規(guī)范

下面,我將對 Android 代碼對象中的命名規(guī)范進行詳細講解

注:由于 Android主要用Java實現(xiàn),所以Android規(guī)范會涵蓋部分Java規(guī)范

3.1 包

  • 基礎(chǔ)規(guī)則:小寫、單詞間連續(xù)無間隔、反域名法(分為4級,具體如下圖)
示意圖
  • 第4級包名會隨著功能的不同而不同。下面我列舉出一些常見 & 需要規(guī)范的4級功能包名
示意圖

3.2 類

  • 基礎(chǔ)規(guī)則
    1. 類型 = 名詞 / 名詞短語;
    2. 形式 = 駝峰形式中的 大駱駝拼寫法UpperCamelCase

即名稱中的每個詞的首字母都大寫,如 AndroidStudio

  • 在具體命名類時,會根據(jù) 該類的類型不同而附加額外的命名規(guī)則。具體如下圖
示意圖

3.3 變量

  • 基礎(chǔ)規(guī)則
    1. 類型 = 名詞 / 名詞短語;
    2. 形式 = 駝峰形式中的 小駱駝拼寫法LowerCamelCase

即名稱中的第1個詞的首字母小寫,后面每個詞的首字母大寫,如androidStudioTool

  • 在具體命名變量時,會根據(jù)該變量的類型不同而 附加額外的命名規(guī)則。具體如下圖
示意圖

3.4 方法

  • 基礎(chǔ)規(guī)則
    1. 類型 = 動詞 / 動詞短語;
    2. 形式 = 駝峰形式中的 小駱駝拼寫法LowerCamelCase

即名稱中的第1個詞的首字母小寫,后面每個詞的首字母大寫,如androidStudioTool

  • 在具體命名 方法名時,會根據(jù) 該方法名的作用不同而 附加額外的命名規(guī)則。具體如下圖
示意圖

3.5 參數(shù)名

  • 基礎(chǔ)規(guī)則:駝峰形式中的 小駱駝拼寫法LowerCamelCase

即名稱中的第1個詞的首字母小寫,后面每個詞的首字母大寫,如androidStudioTool

  • 附加命名規(guī)則:功能名,如userName

3.6 資源

  • Android的資源包括:
示意圖
示意圖

下面,我將對每種Android資源的命名規(guī)則進行詳細講解

3.6.1 布局文件資源

示意圖

3.6.2 圖片資源

示意圖

3.6.3 參數(shù)值資源

示意圖

3.6.4 動畫資源

示意圖

3.7 額外

除了上述的命名規(guī)范以外,Android 中還有一些全局通用的命名規(guī)范:

示意圖

至此,關(guān)于Android的代碼命名規(guī)范講解完畢


4. 附錄:常見使用單詞縮寫表

  • 使用單詞縮寫的原則:只使用約定俗成的單詞縮寫

嚴禁自由縮寫單詞

  • 具體如下圖
示意圖

5. 總結(jié)

  • 看完本文后,相信你以后會認真對待 Android代碼命名了!

  • 下一篇文章我將對講解Android 的相關(guān)知識,感興趣的同學(xué)可以繼續(xù)關(guān)注本人的簡書哦。

相關(guān)系列文章閱讀
Carson帶你學(xué)Android:學(xué)習(xí)方法
Carson帶你學(xué)Android:四大組件
Carson帶你學(xué)Android:自定義View
Carson帶你學(xué)Android:異步-多線程
Carson帶你學(xué)Android:性能優(yōu)化
Carson帶你學(xué)Android:動畫


歡迎關(guān)注Carson_Ho的簡書

不定期分享關(guān)于安卓開發(fā)的干貨,追求短、平、快,但卻不缺深度


請點贊!因為你的鼓勵是我寫作的最大動力!

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

推薦閱讀更多精彩內(nèi)容

  • 食用注意(現(xiàn)在才寫_(:3」∠)) 原著世界描述不多,現(xiàn)代架空ooc,狗血劇情多,原著中跟鳴人的最後一戰(zhàn)有。完全沒...
    莫鴆閱讀 4,707評論 2 6
  • 人生有一萬種可能,你只終于一種嘛? 遲山閑聽雨急落點花紅疑似蓬萊客御云送晚晴 清池雨點豆細露嬌芙蓉一葉纏曲莖信手剝蓮蓬
    青梅3煮酒閱讀 309評論 1 1
  • 除去今天,再過兩天就是新的一年-2017年。這一年的事情竟然好多都想不起來了。是我不愿意記憶吧,不管是高興的不高興...
    望飛雪閱讀 236評論 2 1
  • 摘要: Zookeeper集群安裝 SpringMVC+Mybatis, Dubbo+Zookeeper, jav...
    ITsupuerlady閱讀 181評論 0 0
  • 2016最后一天跟2016的前三百六十四天好像也沒有什么不同,但難能可貴的是201...
    朱想不通閱讀 417評論 6 6