藏友汇代码规范文档

《藏友汇代码规范文档》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、藏友汇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编码格式，在

2、环境配置前先将Eclipse编码格式全部更改为UTF-8。WindowàGeneralàWorkspace在Textfileencoding中选择Other:UTF-8WindowàGeneralàContentTypes在Contenttypes中选择TextàJavaSourceFile在Defaultencoding中写入UTF-8点击Update。一、命名规范。所有的命名必须使用英文，不能出现拼音、汉字、单字母等无意义或无法读懂的命名。1.工程命名根据项目内容与其他终端或服务端统一命名。ProjectName，工程

3、的英文名，首字母大写。2.包命名Java包的名字都是由小写单词组成，采用公司在互联网上的域名称作为自己程序包的唯一前缀。com.b3a4a.project.group3.类命名Java类名通常以大写字母开头，如果类名称由多个单词组成，则每个单词的首字母均应为大写；如果类名称中包含单词缩写，则这个所写词的每个字母均应大写。类结尾应标明该类的类型。FunctionActivityCustomViewListAdapter1.方法命名方法的名字的第一个单词应以小写字母作为开头，后面的单词则用大写字母开头。method()2.常量

4、命名常量的名字应该都使用大写字母，并且指出该常量完整含义。如果一个常量名称由多个单词组成，则应该用下划线来分割这些单词。RESPONSE_OK3.参数命名参数的命名规范和方法的命名规范相同，而且为了避免阅读程序时造成迷惑，请在尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确。在变量命名时要注意以下几点：l选择有意义的名字，注意单词间首字母要大写。l在一段函数中不使用同一个变量表示前后意义不同的两个数值。li、j、k等只作为小型循环的循环索引变量。l避免用Flag来命名状态变量。l用Is来命名逻辑变量。通过给布尔变量

5、肯定形式的命名方式，使得其它开发人员能够更为清楚的理解布尔变量所代表的意义。l如果需要的话，在变量最后附加计算限定词。l命名不相包含。1.控件命名控件在xml中的id应该标明控件所在的模块、类型和名称，在Java代码中应以控件缩写开头。xml:Java:xxx_txt_attributetxt_attributexxx_btn_attributebtn_attributexxx_cbox_attributecbox_attributexxx_radioBtn_attributeradioBtn_attributexxx_i

6、mg_attributeimg_attributexxx_imgBtn_attributeimgBtn_attribute一、工程包结构包结构采用按类型分类，常见的包有：activity、存放所有activity的包adapter、存放所有的适配器bean、存放所有的数据模型biz、存放所有的业务逻辑configs、存放系统的全局静态配置文件database、存放数据库操作文件executors、存放线程事务对象和线程池队列fragment、存放所有的fragment类holder、存放某些复杂适配器的基类holderin

7、terf、存放一些系统公用的回调接口，类内部专用的回调接口建议使用匿名内部类receiver、存放一些广播接收器service、存放一些后台服务servicesort、存放java的排序类utils、存放所有的工具类，这个是非常重要的view、自定义的view对象widget自定义封装的控件一、注释规范Java除了可以采用我们常见的注释方式之外，Java语言规范还定义了一种特殊的注释，也就是我们所说的Javadoc注释，它是用来记录我们代码中的API的。Javadoc注释是一种多行注释，以/**开头，而以*/结束，注释可以

8、包含一些HTML标记符和专门的关键词。使用Javadoc注释的好处是编写的注释可以被自动转为在线文档，省去了单独编写程序文档的麻烦。在每个程序的最开始部分，一般都用Javadoc注释对程序的总体描述以及版权信息，之后在主程序中可以为每个类、接口、方法、字段添加Javadoc注释，每个注释的开头部分先用一