前言
根据 Google Java 编程规范 & Google 官方 Android 编码规范,整理一份全面 & 清晰的Android
代码命名规范
目录
1. 为什么 规范 Android 代码命名?
- 增强代码的可读性
- 增强代码的可维护性
正由于上述两个作用,从而使得 开发效率 & 维护效率 得到大幅度的提高。
2. Android 需要命名的代码(对象)有哪些?
3. 具体命名规范
下面,我将对 Android
代码对象中的命名规范进行详细讲解
注:由于
Android
主要用Java
实现,所以 Android 规范会涵盖部分 Java 规范
3.1 包
- 基础规则:小写、单词间连续无间隔、反域名法(分为 4 级,具体如下图)
- 第 4 级包名会随着功能的不同而不同。下面我列举出一些常见 & 需要规范的 4 级功能包名
3.2 类
- 基础规则
- 类型 = 名词 / 名词短语;
- 形式 = 驼峰形式中的 大骆驼拼写法(
UpperCamelCase
)
即名称中的每个词的首字母都大写,如
AndroidStudio
- 在具体命名类时,会根据 该类的类型不同而附加额外的命名规则。具体如下图
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
中还有一些全局通用的命名规范:
至此,关于Android
的代码命名规范讲解完毕
4. 附录:常见使用单词缩写表
- 使用单词缩写的原则:只使用约定俗成的单词缩写
严禁自由缩写单词
- 具体如下图
网友评论