前言
无论你是个人开发还是团队,一个良好的代码规范,能够在项目当中发挥举足轻重的作用;它不仅能使你们的开发更加高效,而且还会减少BUG产生的几率,增强代码可维护性及稳定性。
下面分享给大家这份来自阿里《Android代码规范指南》,如果你耐心看完,一定会提升代码质量,让你写出诗一样的代码。
1. Android 的工具规范
工欲善其事,必先利其器。由于 Android 基本都基于 Android Studio 进行开发,所以工具规范全部以 Android Studio 为前提。
2. Android 的分包规范
前面强调了工具的统一配置,再利用 Android Studio 本身的功能便可把代码风格变得一致。接下来就带来第二部分:Android 的分包规范。对于分包,我们需要达成一致,我们采用 PBF 方式,不推荐使用 PBL 方式。
3. Android 的命名规范
代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。正确的英文拼写和语法可以让阅读者易于理解,避免歧义。
- 包名
- 类名
- 方法名
- 变量命名
- 资源命名
4.Android 的注释规范
- 类注释
- 方法注释
- 块注释
- 全局变量的注释
- 其他一些注释
- 注释必须遵守的规范
5. 代码样式规范
- 使用标准大括号样式
- 编写简短方法
- 类成员的顺序
- 函数参数的排序
- 字符串常量的命名和值
- 行长限制
6.资源文件规范
资源文件命名为全部小写,采用下划线命名法。
如果是组件化开发,我们可以在组件和公共模块间创建一个 ui 模块来专门存放资源文件,然后让每个组件都依赖 ui
模块。这样做的好处是如果老项目要实现组件化的话,只需把资源文件都放入 ui 模块即可。
如果是三方库开发,其使用到的资源文件及相关的 name 都应该使用库名作为前缀,这样做可以避免三方库资源和实际应用资源重名的冲突。
- 动画资源文件(anim/ 和 animator/)
- 颜色资源文件(color/)
- 图片资源文件(drawable/ 和 mipmap/)
- 布局资源文件(layout/)
- 菜单资源文件(menu/)
- values 资源文件(values/)
- id 命名
7.版本统一规范
8.第三方库规范
9.测试规范
- 单元测试
- Espresso 测试
10.其他的一些规范
11.编码规约
12.常量定义
13.异常处理
14.Android 实践
需要完整版的小伙伴微信扫描CSDN官方认证二维码免费获取