Android 你不能忽略的代码命名规范

作者:Carson_Ho

链接:

https://www.jianshu.com/p/b7a644ea0d25

本文由作者授权发布。


  • Android代码规范内容非常多,但对我们最有用& 最有影响的莫过于  Android代码的命名规范

  • 可是,有很多人容易忽略Android代码的命名规范,从而导致代码的可读性 & 维护性非常差,最终导致开发效率 & 维护效率降低

  • 今天,我将根据 Google Java 编程规范 &  Google 官方 Android 编码规范,为大家带来一份全面 & 清晰的Android代码命名规范,希望你们会喜欢。


  • http://www.hawstein.com/posts/google-java-style.html

  • http://www.360sdn.com/2013/android_0517/144.html



目录

640?wx_fmt=other


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


  • 增强代码的可读性

  • 增强代码的可维护性


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


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


640?wx_fmt=other


3 具体命名规范


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


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


3.1 包


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


640?wx_fmt=other


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


640?wx_fmt=png


3.2 类


基础规则


  1. 类型 = 名词 / 名词短语;

  2. 形式 = 驼峰形式中的 大骆驼拼写法(UpperCamelCase)


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


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


具体如下图:


640?wx_fmt=png


3.3 变量


基础规则


  1. 类型 = 名词 / 名词短语;

  2. 形式 = 驼峰形式中的 小骆驼拼写法(LowerCamelCase)


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


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


具体如下图:


640?wx_fmt=png


3.4 方法


基础规则


  1. 类型 = 动词 / 动词短语;

  2. 形式 = 驼峰形式中的 小骆驼拼写法(LowerCamelCase


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


在具体命名 方法名时,会根据 该方法名的作用不同而 附加额外的命名规则。


具体如下图


640?wx_fmt=png


3.5 参数名


基础规则:


驼峰形式中的 小骆驼拼写法(LowerCamelCase)


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


附加命名规则:


功能名,如userName


3.6 资源


Android的资源包括:


640?wx_fmt=png


640?wx_fmt=png

下面,我将对每种Android资源的命名规则进行详细讲解


3.6.1 布局文件资源


640?wx_fmt=png


3.6.2 图片资源


640?wx_fmt=png


3.6.3 参数值资源


640?wx_fmt=png


3.6.4 动画资源


640?wx_fmt=png


3.7 额外


除了上述的命名规范以外,Android 中还有一些全局通用的命名规范:


640?wx_fmt=png


至此,关于Android的代码命名规范讲解完毕


4 附录:常见使用单词缩写表


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


严禁自由缩写单词


具体如下图


640?wx_fmt=png


总结


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


下面我将继续对Android中的其他代码规范进行深入讲解 ,有兴趣可以继续关注Carson_Ho的安卓开发笔记

https://www.jianshu.com/u/383970bef0a0

                        喜欢 就关注吧,欢迎投稿!

640?wx_fmt=jpeg



  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值