藏友汇代码规范文档.docx

藏友汇Android 工程师开发手册V1.0修订记录版本时间修改（拟制）人修改说明V1.020140524藏友汇第一版开发手册，主要规范编码目录Android 工程师开发手册1目录2一、编码格式。3二、命名规范。31.工程命名32.包命名33.类命名44.方法命名45.常量命名46.参数命名47.控件命名5三、工程包结构5四、注释规范5五、异常处理61.不能忽视异常处理62.不能偷懒而捕捉一般异常6六、图片资源分类7七、代码复用7八、单元测试7九、团队合作7十、版本发布8一、 编码格式。公司项目编码全部采取UTF-8编码格式，在环境配置前先将Eclipse编码格式全部更改为UTF-8。Window General Workspace在Text file encoding中选择Other:UTF-8Window General ContentTypes在Content types中选择Text Java Source File在Default encoding中写入UTF-8点击Update。二、 命名规范。所有的命名必须使用英文，不能出现拼音、汉字、单字母等无意义或无法读懂的命名。1. 工程命名根据项目内容与其他终端或服务端统一命名。ProjectName，工程的英文名，首字母大写。2. 包命名Java包的名字都是由小写单词组成，采用公司在互联网上的域名称作为自己程序包的唯一前缀。ject.group3. 类命名Java类名通常以大写字母开头，如果类名称由多个单词组成，则每个单词的首字母均应为大写；如果类名称中包含单词缩写，则这个所写词的每个字母均应大写。类结尾应标明该类的类型。FunctionActivityCustomViewListAdapter4. 方法命名方法的名字的第一个单词应以小写字母作为开头，后面的单词则用大写字母开头。method()5. 常量命名常量的名字应该都使用大写字母，并且指出该常量完整含义。如果一个常量名称由多个单词组成，则应该用下划线来分割这些单词。RESPONSE_OK6. 参数命名参数的命名规范和方法的命名规范相同，而且为了避免阅读程序时造成迷惑，请在尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确。在变量命名时要注意以下几点：l 选择有意义的名字，注意单词间首字母要大写。l 在一段函数中不使用同一个变量表示前后意义不同的两个数值。l i、j、k等只作为小型循环的循环索引变量。l 避免用Flag来命名状态变量。l 用Is来命名逻辑变量。通过给布尔变量肯定形式的命名方式，使得其它开发人员能够更为清楚的理解布尔变量所代表的意义。l 如果需要的话，在变量最后附加计算限定词。l 命名不相包含。7. 控件命名控件在xml中的id应该标明控件所在的模块、类型和名称，在Java代码中应以控件缩写开头。xml:Java:xxx_txt_ attributetxt_ attribute xxx_btn_ attributebtn_ attributexxx_cbox_ attributecbox_ attributexxx_radioBtn_ attributeradioBtn_ attributexxx_img_ attributeimg_ attributexxx_imgBtn_ attributeimgBtn_ attribute三、 工程包结构包结构采用按类型分类，常见的包有：activity、存放所有activity的包adapter、存放所有的适配器bean、存放所有的数据模型biz、存放所有的业务逻辑configs、存放系统的全局静态配置文件database、存放数据库操作文件executors、存放线程事务对象和线程池队列fragment、存放所有的fragment类holder、存放某些复杂适配器的基类holderinterf、存放一些系统公用的回调接口，类内部专用的回调接口建议使用匿名内部类receiver、存放一些广播接收器service、存放一些后台服务servicesort、存放java的排序类utils、存放所有的工具类，这个是非常重要的view、自定义的view对象widget自定义封装的控件四、 注释规范Java除了可以采用我们常见的注释方式之外，Java语言规范还定义了一种特殊的注释，也就是我们 所说的Javadoc注释，它是用来记录我们代码中的API的。Javadoc注释是一种多行注释，以/*开头，而以*/结束，注释可以包含一些 HTML标记符和专门的关键词。使用Javadoc 注释的好处是编写的注释可以被自动转为在线文档，省去了单独编写程序文档的麻烦。在每个程序的最开始部分，一般都用Javadoc注释对程序的总体描述以及版权信息，之后在主程序中 可以为每个类、接口、方法、字段添加 Javadoc注释，每个注释的开头部分先用一句话概括该类、接口、方法、字段所完成的功能，这句话应单独占据一行以突出其概括作用，在这句话后面可以跟随更加详细的描述段落。在描述性段落之后还可以跟随一些以Javadoc注释标签开头的特殊段落，例如上面例子中的auther和version，这些段落将在生成文档中以特定方式显示。强调代码中任何类，变量，方法都需要进行注释，除非是覆盖的系统方法或者是自动生成的Set和Get方法Javadoc的注释设置：WindowPreferencesJavaCode Style Code Templates变量注释：（Fields）/* 变量描述*/类注释：（Files、Types）/* * Description TODO * author * date $date * Copyright: Copyright (c) $year Shenzhen b3a4a Technology Co., Ltd. Inc. All rights reserved. */方法注释：（Constructors、Methods、Methods 、Overriding Methods、Delegate Methods）/* * (此处输入方法执行任务.) * * version 1.0 * createTime $date,$time * updateTime $date,$time * createAuthor * updateAuthor * updateInfo (此处输入修改内容,若无修改可不写.) * $tags */五、 异常处理1. 不能忽视异常处理catch后的异常需作出合理的处理，若为公用的方法需要不同的处理则抛出改异常到方法外。2. 不能偷懒而捕捉一般异常捕捉Exception异常，大小通吃是不对的，这样会让你在错误出现时难以定位到错误原因，一般异常无法用统一方法进行异常处理。六、 图片资源分类不同解析度的图片资源分放在不同解析度的包里。若横纵向可完全拉伸的图片则放入至统一的通用的文件夹中。七、 代码复用发如果是工程中重复使用的代码，必须提取成工具类或者是自定义控件，不允许直接copy代码，以便提高整个工程的代码复用率，也降低后期的开发和维护成本。如果是类似或者是可继承的类，需要灵活的应用继承，提高代码的可读性和复用性。在自己编写好工具类或者自定义控件的时候应该知会所有项目组相关android成员，以遍不重复制造轮子。另外自己在编写工具类之前可以咨询其他成员或者其他项目的android成员有否类似的工具类可使用，如果有就在现有的基础上去晚上，保持技术共享的良好习惯和氛围。八、 单元测试开发在完成一个功能模块的时候必须进行单元测试，检验在特殊值的情况下该代码片段是否会出现异常，如果出现异常应该如何去处理，保证每个功能单元在数据存在缺陷的时候都不会引起代码崩溃。九、 团队合作在开发的过程中，团队间的密切配合尤其重要，每个成员之间应该分工明确，保持良好的沟通，确保一切都是在清晰明朗的条件下进行的，我们不需要埋头苦干的人，我们需要一个善于沟通，乐于帮助团队其他成员解决问题的人，当你遇到困难的时候，同样可以寻求其他成员的帮助，我们的目标是把整个项目做好，而不仅仅只是把自己的任务做好。Svn是团队间代码版本控制的工具，每一位成员应该养成经常提交代码的良好习惯，这会为你免受代码丢失带来的困扰，在你提交代码的时候应该及时知会团队相关人员，以便每个人都有最新的完整代码，减少文件的冲突概率，每次提交的时候必须写上本次提交的修改内容，如果改动非常小的可以适当忽略。在遇到代码冲突的时候应该选择去解决冲突，而不是还原成自己的版本，解决Svn的代码冲突也是作为团队一员的必备技能。团队之间应该养成良好的技术探讨氛围，一起去解决技术难点，或者分享自己攻克的技术问题给其他团队成员，自己不足的地方应该虚心向其他成员请教，或者多上网查找资料学习，作为开发者应该拥有一定独立解决问题的能力，如果是无法解决的问题应该及时向上反映，以便能及时处理风险。十、 版本发布在对外发布一个版本的时候，应该非常慎重，仔细的做好以下几步，不然吃亏的一定会是你自己！1、 先检查服务器API配置是否切换到生产环境，主配置文件里边