Carson带你学Android:你不能忽略的代码命名规范

前言

  • 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. 附录:常见使用单词缩写表

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

严禁自由缩写单词

  • 具体如下图
示意图

5. 总结

  • 看完本文后,相信你以后会认真对待 Android代码命名了!

  • 下一篇文章我将对讲解Android 的相关知识,感兴趣的同学可以继续关注本人的简书哦。

相关系列文章阅读
Carson带你学Android:学习方法
Carson带你学Android:四大组件
Carson带你学Android:自定义View
Carson带你学Android:异步-多线程
Carson带你学Android:性能优化
Carson带你学Android:动画


欢迎关注Carson_Ho的简书

不定期分享关于安卓开发的干货,追求短、平、快,但却不缺深度


请点赞!因为你的鼓励是我写作的最大动力!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 食用注意(現在才寫_(:3」∠)) 原著世界描述不多,現代架空ooc,狗血劇情多,原著中跟鳴人的最後一戰有。完全沒...
    莫鴆阅读 4,736评论 2 6
  • 人生有一万种可能,你只终于一种嘛? 迟山闲听雨急落点花红疑似蓬莱客御云送晚晴 清池雨点豆细露娇芙蓉一叶缠曲茎信手剥莲蓬
    青梅3煮酒阅读 315评论 1 1
  • 除去今天,再过两天就是新的一年-2017年。这一年的事情竟然好多都想不起来了。是我不愿意记忆吧,不管是高兴的不高兴...
    望飞雪阅读 247评论 2 1
  • 摘要: Zookeeper集群安装 SpringMVC+Mybatis, Dubbo+Zookeeper, jav...
    ITsupuerlady阅读 184评论 0 0
  • 2016最后一天跟2016的前三百六十四天好像也没有什么不同,但难能可贵的是201...
    朱想不通阅读 425评论 6 6