目錄
- 目錄
- 1、為什么 規范 Android 代碼命名?
- 2、Android需要命名的代碼(對象)有哪些?
- 3、具體命名規范
- 3.1、包
- 3.2、類
- 3.3、變量
- 3.4、方法
- 3.5、參數名
- 3.6、資源
- 3.6.1、布局文件資源
- 3.6.2、圖片資源
- 3.6.3、參數值資源
- 3.6.4、動畫資源
- 3.7、額外
- 4、附錄:常見使用單詞縮寫表
目錄
1、為什么 規范 Android 代碼命名?
- 增強代碼的可讀性
- 增強代碼的可維護性
正由于上述兩個作用,從而使得 開發效率
& 維護效率
得到大幅度的提高。
2、Android需要命名的代碼(對象)有哪些?
3、具體命名規范
下面,我將對 Android
代碼對象中的命名規范進行詳細講解
注:由于
Android
主要用Java
實現,所以Android規范會涵蓋部分Java規范
3.1、包
基礎規則
:小寫、單詞間連續無間隔、反域名法(分為4級,具體如下圖)
第4級包名會隨著功能的不同而不同
。下面我列舉出一些常見 & 需要規范的4級功能包名:
功能模塊 | 命名規則 | 功能模塊 | 命名規則 |
---|---|---|---|
Activity | com.x.y.activity | 基礎共享 | com.x.y.base |
Service服務 | com.x.y.service | Adapter類(適配器) | com.x.y.adapter |
廣播服務 | com.x.y.receiver | 數據庫操作 | 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、變量
基礎規則:
- 類型 = 名詞 / 名詞短語;
- 形式 = 駝峰形式中的 小駱駝拼寫法(LowerCamelCase)。
即名稱中的第1個詞的首字母小寫,后面每個詞的首字母大寫,如androidStudioTool
在具體命名變量時,會根據該變量的類型不同而 附加額外的命名規則。具體如下圖:
3.4、方法
基礎規則:
- 類型 = 動詞 / 動詞短語;
- 形式 = 駝峰形式中的 小駱駝拼寫法(LowerCamelCase)。
即名稱中的第1個詞的首字母小寫,后面每個詞的首字母大寫,如androidStudioTool
在具體命名 方法名時,會根據該方法名的作用不同而 附加額外的命名規則。具體如下圖:
3.5、參數名
基礎規則:
- 駝峰形式中的小駱駝拼寫法(LowerCamelCase)
即名稱中的第1個詞的首字母小寫,后面每個詞的首字母大寫,如androidStudioTool
附加命名規則: 功能名,如userName
3.6、資源
Android的資源包括:
下面,我將對每種Android資源的命名規則進行詳細講解:
3.6.1、布局文件資源
3.6.2、圖片資源
3.6.3、參數值資源
3.6.4、動畫資源
3.7、額外
除了上述的命名規范以外,Android
中還有一些全局通用的命名規范:
4、附錄:常見使用單詞縮寫表
使用單詞縮寫的原則:只使用約定俗成的單詞縮寫
嚴禁自由縮寫單詞
具體如下圖:
?
?