android 项目交接文档,Android实用开发规范

本文中选择将开发规范作为这个系列的第一篇文章，就是个人感觉产品研发过程中，开发规范真的很重要，很重要，非常重要(重要的事情说三遍)，一个好的开发规范可以让团队中的人对他人的代码更熟悉，新人也可以更好的了解产品的业务逻辑。开发规范并不是一个死的一成不变的，每个团队可能都有自己的开发规范，只要是适合团队的开发规范就是最好的开发规范。

所以本文中所讲解的开发规范只能是抛砖引玉，有可取的地方可以借鉴，引用，不能照搬全抄不假思索，毕竟不同的团队有不同的实际情况。最好的方式就是可以根据本文的开发规范总结出自身团队比较适合的规范流程。

好吧，废话不多说了，下面我们就介绍一下我在实践中总结的Android开发规范。

1 前言

1.1 为什么需要开发规范

编码规范对于程序员而言尤为重要，有以下几个原因：

* 一个软件的生命周期中，80%的花费在于维护

* 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护

* 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码

* 如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品

1.2 开发规范的作用

* 减少维护花费

* 提高可读性

* 加快工作交接

* 减少名字增生

* 降低缺陷引入的机会

2 命名规范

2.1 常量命名规范

2.1.1 类型

常量命名规范

2.1.2 说明

常量用于保存需要常驻内存中并且经常使用变化不多的数据，定义常量的名称的时候需要遵循望文知意的原则；

2.1.3 规则

全部为大写字母；

中间以“_”连接；

望文知意原则；

2.1.4 备注

代码中涉及到直接使用某个字符串或者其他基本类型的值时，建议定义成常量，避免多处直接使用同样的值作为参数。

2.1.5 举例

如：定义一个常量表示最小屏幕宽度的常量，则可以定义一个int类型的常量，该常量可以命名为：“MIN_SCREEN_WIDTH“；

其他举例：

例如：static final int MIN_SCREEN_WIDTH = 4；( √)

例如：static final int min_screen_width = 4;(×)

例如：static final int minScreenWidth = 4; (×)

例如：static final int WIDTH = 4；(×)

例如：static final int width = 4；(×)

例如：static final int wd = 4；(×)

2.2 变量命名规范

2.2.1 类型

变量命名规范

2.2.2 说明

变量用于保存系统中的临时数据，变量命名时遵循望文知意，简单明了，驼峰标示等原则。

2.2.3 规则

首字母小写；

java驼峰命名；

望文知意原则；

推荐引用类型变量添加前缀“m”；

如果是View组件变量，则组件名称为xml文件中定义的ID名称去掉下划线，下划线后一位大写；

2.2.4 备注

无

2.2.5 举例

如：定义一个表示最小屏幕宽度的变量，则可以定义一个int型的临时变量为：mMinScreenWidth；

例如：static final int mMinScreenWidth = 4； ( √)

例如：static final int minWidth = 4；(×)

例如：static final int screenWidth = 4；(×)

例如：static final int width = 4；(×)

例如：static final int min = 4； (×)

例如：static final int msw = 4； (×)

2.3 方法命名规范<