z

前言

  • Android代码规范内容非常多,但对我们最有用& 最有影响的莫过于 Android代码的命名规范
  • 可是,有很多人容易忽略Android代码的命名规范,从而导致代码的可读性 & 维护性非常差,最终导致开发效率 & 维护效率降低
  • 今天,我将根据 Google Java 编程规范 & Google 官方 Android 编码规范,为大家带来一份全面 &
    清晰的Android代码命名规范
    ,希望你们会喜欢。

目录


1. 为什么 规范 Android 代码命名?

  • 增强代码的可读性
  • 增强代码的可维护性

正由于上述两个作用,从而使得 开发效率 & 维护效率 得到大幅度的提高。


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


3. 具体命名规范

下面,我将对 Android代码对象中的命名规范进行详细讲解

注:由于 Android主要用Java实现,所以Android规范会涵盖部分Java规范

3.1 包
  • 基础规则:小写、单词间连续无间隔、反域名法(分为4级,具体如下图)

  • 第4级包名会随着功能的不同而不同。下面我列举出一些常见 & 需要规范的4级功能包名


3.2 类
  • 基础规则
  1. 类型 = 名词 / 名词短语;
  2. 形式 = 驼峰形式中的 大骆驼拼写法UpperCamelCase

即名称中的每个词的首字母都大写,如 AndroidStudio

  • 在具体命名类时,会根据 该类的类型不同而附加额外的命名规则。具体如下图


3.3 变量
  • 基础规则
  1. 类型 = 名词 / 名词短语;
  2. 形式 = 驼峰形式中的 小骆驼拼写法lowerCamelCase

即名称中的第1个词的首字母小写,后面每个词的首字母大写,如androidStudioTool

  • 在具体命名变量时,会根据该变量的类型不同而 附加额外的命名规则。具体如下图

3.4 方法
  • 基础规则
  1. 类型 = 动词 / 动词短语;
  2. 形式 = 驼峰形式中的 小骆驼拼写法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. 附录:常见使用单词缩写表

  • 使用单词缩写的原则:只使用约定俗成的单词缩写

严禁自由缩写单词

  • 具体如下图

以上就是 Android的 一些 常用的 命名规范
本文内容转载至 :https://www.jianshu.com/p/b7a644ea0d25

更多相关文章

  1. 从Android项目学习Kotlin(一)
  2. 如何获取Android源码
  3. Android之GridView简单说明
  4. Android基于XMPP Smack Openfire开发IM(2)登录openfire
  5. Android(安卓)Service详解(三) AIDL使用解析
  6. 在代码中实现android:tint效果
  7. android 中 application 的使用
  8. Android(安卓)高手进阶教程(十三)之----Android(安卓)数据库SQLi
  9. Android(安卓)Studio NDK开发在C代码中将Log输出到logcat上面

随机推荐

  1. Android(安卓)Jni NDK 打印log日志
  2. Android中向SD卡读写数据,读SD卡和手机内
  3. 〖Android〗酷派手机固件.cpb文件的分解
  4. android WebView 详细代码
  5. Android中判断网络连接是否可用及监控网
  6. ListView 滑动出现黑色边际问题
  7. android editview与popwindow焦点冲突
  8. android中去掉标题栏和状态栏
  9. android WebView 拍照上传图片兼容
  10. android 比较精简的list对话框代码