Android代码命名规范
目錄
- 目錄
- 1、為什么 規(guī)范 Android 代碼命名?
- 2、Android需要命名的代碼(對(duì)象)有哪些?
- 3、具體命名規(guī)范
- 3.1、包
- 3.2、類
- 3.3、變量
- 3.4、方法
- 3.5、參數(shù)名
- 3.6、資源
- 3.6.1、布局文件資源
- 3.6.2、圖片資源
- 3.6.3、參數(shù)值資源
- 3.6.4、動(dòng)畫資源
- 3.7、額外
- 4、附錄:常見使用單詞縮寫表
目錄
1、為什么 規(guī)范 Android 代碼命名?
- 增強(qiáng)代碼的可讀性
- 增強(qiáng)代碼的可維護(hù)性
正由于上述兩個(gè)作用,從而使得 開發(fā)效率 & 維護(hù)效率 得到大幅度的提高。
2、Android需要命名的代碼(對(duì)象)有哪些?
3、具體命名規(guī)范
下面,我將對(duì) Android 代碼對(duì)象中的命名規(guī)范進(jìn)行詳細(xì)講解
注:由于 Android 主要用 Java 實(shí)現(xiàn),所以Android規(guī)范會(huì)涵蓋部分Java規(guī)范
3.1、包
基礎(chǔ)規(guī)則:小寫、單詞間連續(xù)無間隔、反域名法(分為4級(jí),具體如下圖)
說明模板 : com.x.y.zcom = 1級(jí)包名 = 固定comx = 2級(jí)包名 = 公司/個(gè)人
y = 3級(jí)包名 = 應(yīng)用名
z = 4級(jí)包名 = 功能模塊名示例com.davis.wechat.login
第4級(jí)包名會(huì)隨著功能的不同而不同。下面我列舉出一些常見 & 需要規(guī)范的4級(jí)功能包名:
常見 & 規(guī)范的 第四級(jí)包名 (基礎(chǔ)規(guī)則:小寫、單詞間連續(xù)無間隔、反域名法)| Activity | com.x.y.activity | 基礎(chǔ)共享 | com.x.y.base |
| Service服務(wù) | com.x.y.service | Adapter類(適配器) | com.x.y.adapter |
| 廣播服務(wù) | com.x.y.receiver | 數(shù)據(jù)庫操作 | com.x.y.db |
| 模型類 | com.x.y.model | 公共工具方法 | com.x.y.util |
| 自定義View | com.x.y.view | JavaBean | com.x.y.bean |
3.2、類
3.3、變量
基礎(chǔ)規(guī)則:
- 類型 = 名詞 / 名詞短語;
- 形式 = 駝峰形式中的 小駱駝拼寫法(LowerCamelCase)。
即名稱中的第1個(gè)詞的首字母小寫,后面每個(gè)詞的首字母大寫,如androidStudioTool
在具體命名變量時(shí),會(huì)根據(jù)該變量的類型不同而 附加額外的命名規(guī)則。具體如下圖:
3.4、方法
基礎(chǔ)規(guī)則:
- 類型 = 動(dòng)詞 / 動(dòng)詞短語;
- 形式 = 駝峰形式中的 小駱駝拼寫法(LowerCamelCase)。
即名稱中的第1個(gè)詞的首字母小寫,后面每個(gè)詞的首字母大寫,如androidStudioTool
在具體命名 方法名時(shí),會(huì)根據(jù)該方法名的作用不同而 附加額外的命名規(guī)則。具體如下圖:
3.5、參數(shù)名
基礎(chǔ)規(guī)則:
- 駝峰形式中的小駱駝拼寫法(LowerCamelCase)
即名稱中的第1個(gè)詞的首字母小寫,后面每個(gè)詞的首字母大寫,如androidStudioTool
附加命名規(guī)則: 功能名,如userName
3.6、資源
Android的資源包括:
下面,我將對(duì)每種Android資源的命名規(guī)則進(jìn)行詳細(xì)講解:
3.6.1、布局文件資源
3.6.2、圖片資源
3.6.3、參數(shù)值資源
3.6.4、動(dòng)畫資源
3.7、額外
除了上述的命名規(guī)范以外,Android 中還有一些全局通用的命名規(guī)范:
4、附錄:常見使用單詞縮寫表
使用單詞縮寫的原則:只使用約定俗成的單詞縮寫
嚴(yán)禁自由縮寫單詞
具體如下圖:
?
?
總結(jié)
以上是生活随笔為你收集整理的Android代码命名规范的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 宁波银行现金易如何还款?两种还款方式任你
- 下一篇: Android设计模式之——原型模式