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 类
- 基础规则
- 类型 = 名词 / 名词短语;
- 形式 = 驼峰形式中的 大骆驼拼写法(
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. 附录:常见使用单词缩写表
- 使用单词缩写的原则:只使用约定俗成的单词缩写
严禁自由缩写单词
- 具体如下图
5. 总结
看完本文后,相信你以后会认真对待
Android
代码命名了!下面我将继续对
Android
中的其他代码规范进行深入讲解 ,感兴趣的同学可以继续关注本人运营的Wechat Public Account
:我想给你们介绍一个与众不同的Android微信公众号(福利回赠)
我想邀请您和我一起写Android(福利回赠)
请点赞!因为你的鼓励是我写作的最大动力!
相关文章阅读
Android开发:最全面、最易懂的Android屏幕适配解决方案
Android事件分发机制详解:史上最全面、最易懂
Android开发:史上最全的Android消息推送解决方案
Android开发:最全面、最易懂的Webview详解
Android开发:JSON简介及最全面解析方法!
Android四大组件:Service服务史上最全面解析
Android四大组件:BroadcastReceiver史上最全面解析
欢迎关注Carson_Ho的!
不定期分享关于安卓开发的干货,追求短、平、快,但却不缺深度。
更多相关文章
- Android中几种常见的定时刷新方式
- android lint 是什么
- android之Android中的SQL查询语句LIKE绑定参数问题解决办法(sqlit
- Android开发利器之Data Binding Compiler V2,databind和livedata
- The application has stopped unexpectedly
- Android(安卓)NDK简介
- Android(安卓)实现程序完全退出
- Android(安卓)String format
- Android(安卓)2.3.x WebView中的两个搞笑的bug