Android 开发工程师手册V1.0.docxVIP

Android 工程师开发手册 V1.0 修订记录 版本 时间 修改（拟制）人 修改说明 V1.0Beata(root@) 第一版开发手册，主要规范编码 目录 TOC \o 1-4 Android 工程师开发手册 1 目录 2 前言 3 一、 编码格式。 3 二、 命名规范。 3 1. 工程命名 3 2. 包命名 3 3. 类命名 4 4. 方法命名 4 5. 常量命名 4 6. 参数命名 4 7. 控件命名 5 三、 工程包结构 5 四、 注释规范 5 五、 异常处理 6 1. 不能忽视异常处理 6 2. 不能偷懒而捕捉一般异常 6 六、 图片资源分类 7 七、 代码复用 7 八、 单元测试 7 九、 团队合作 7 十、 版本发布 8 前言 欢迎加入android开发工程师一员，作为团队的一员，应该严格按照以下的开发手册来规范自己的工作，如果有更好的建议或者意见也欢迎踊跃提出，我们将一起完善属于我们团队的开发流程，属于我们团队的开发氛围，希望每一位成员都是充满激情的为了整个团队而努力奋斗！ 编码格式。 公司项目编码全部采取UTF-8编码格式，在环境配置前先将Eclipse编码格式全部更改为UTF-8。 Window ? General ? Workspace在Text file encoding中选择Other:UTF-8 Window ? General ? ContentTypes在Content types中选择Text ? Java Source File在Default encoding中写入UTF-8点击Update。 命名规范。 所有的命名必须使用英文，不能出现拼音、汉字、单字母等无意义或无法读懂的命名。 工程命名 根据项目内容与其他终端或服务端统一命名。 ProjectName，工程的英文名，首字母大写。 包命名 Java包的名字都是由小写单词组成，采用公司在互联网上的域名称作为自己程序包的唯一前缀。 ject.group 类命名 Java类名通常以大写字母开头，如果类名称由多个单词组成，则每个单词的首字母均应为大写；如果类名称中包含单词缩写，则这个所写词的每个字母均应大写。类结尾应标明该类的类型。 FunctionActivity CustomView ListAdapter 方法命名 方法的名字的第一个单词应以小写字母作为开头，后面的单词则用大写字母开头。 method() 常量命名 常量的名字应该都使用大写字母，并且指出该常量完整含义。如果一个常量名称由多个单词组成，则应该用下划线来分割这些单词。 RESPONSE_OK 参数命名 参数的命名规范和方法的命名规范相同，而且为了避免阅读程序时造成迷惑，请在尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确。 在变量命名时要注意以下几点： 选择有意义的名字，注意单词间首字母要大写。 在一段函数中不使用同一个变量表示前后意义不同的两个数值。 i、j、k等只作为小型循环的循环索引变量。 避免用Flag来命名状态变量。 用Is来命名逻辑变量。通过给布尔变量肯定形式的命名方式，使得其它开发人员能够更为清楚的理解布尔变量所代表的意义。 如果需要的话，在变量最后附加计算限定词。 命名不相包含。 控件命名 控件在xml中的id应该标明控件所在的模块、类型和名称，在Java代码中应以控件缩写开头。 xml: Java: xxx_txt_ attribute txt_ attribute xxx_btn_ attribute btn_ attribute xxx_cbox_ attribute cbox_ attribute xxx_radioBtn_ attribute radioBtn_ attribute xxx_img_ attribute img_ attribute xxx_imgBtn_ attribute imgBtn_ attribute 工程包结构 包结构采用按类型分类，常见的包有： activity、 存放所有activity的包 adapter、 存放所有的适配器 bean、 存放所有的数据模型 biz、 存放所有的业务逻辑 configs、 存放系统的全局静态配置文件 database、 存放数据库操作文件 executors、 存放线程事务对象和线程池队列 fragment、 存放所有的fragment类 holder、 存放某些复杂适配器的基类holder interf、 存放一些系统公用的回调接口，类内部专用的回调接口建议使用匿名内部类 receiver、 存放一些广播接收器 service、 存放一些后台