前言
- 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ī)則
- 類型 = 名詞 / 名詞短語;
- 形式 = 駝峰形式中的 大駱駝拼寫法(
UpperCamelCase
)
即名稱中的每個詞的首字母都大寫,如
AndroidStudio
- 在具體命名類時,會根據(jù) 該類的類型不同而附加額外的命名規(guī)則。具體如下圖
3.3 變量
- 基礎(chǔ)規(guī)則
- 類型 = 名詞 / 名詞短語;
- 形式 = 駝峰形式中的 小駱駝拼寫法(
LowerCamelCase
)
即名稱中的第1個詞的首字母小寫,后面每個詞的首字母大寫,如
androidStudioTool
- 在具體命名變量時,會根據(jù)該變量的類型不同而 附加額外的命名規(guī)則。具體如下圖
3.4 方法
- 基礎(chǔ)規(guī)則
- 類型 = 動詞 / 動詞短語;
- 形式 = 駝峰形式中的 小駱駝拼寫法(
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ā)的干貨,追求短、平、快,但卻不缺深度。