旗鱼移动Android开发规范
Posted SpringL
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了旗鱼移动Android开发规范相关的知识，希望对你有一定的参考价值。
目录
3.2 注释
一、Android开发框架
旗鱼移动Android开发项目统一采用公司Android开发框架。
二、命名规范
2.1 包（packages）命名规范
采用反域名命名规则，全部使用小写字母。一级包名为com，二级包名为qiyu，三级包名根据应用进行命名，四级包名为模块名或层级名等。
|
包名 |
此包中包含 |
|
com.qiyu.应用名称缩写.ui.activity |
页面用到的Activity类 (activities层级名用户界面层) |
|
com.qiyu.应用名称缩写.ui.fragment |
页面用到的Fragment类 |
|
com.qiyu.应用名称缩写.adapter |
页面用到的Adapter类 (适配器的类) |
|
com.qiyu.应用名称缩写.utils/tools |
此包中包含：公共工具方法类（utils/tools模块名） |
|
com.qiyu.应用名称缩写.response.data |
网络请求返回response层级1 |
|
com.qiyu.应用名称缩写.response.bean |
网络请求返回response层级2 |
|
com.qiyu.应用名称缩写.response.entity |
网络请求返回response层级3 |
|
com.qiyu.应用名称缩写.bean/entity |
此包中包含：元素类 |
|
com.qiyu.应用名称缩写.db |
数据库操作类 |
|
com.qiyu.应用名称缩写.view |
自定义的View类等 |
|
com.qiyu.应用名称缩写.XXXX |
其他定义的包名 |
2.2 类（classes）命名规范
采用大驼峰命名法，尽量避免缩写，除非该缩写是众所周知的， 比如html,URL，如果类名称中包含单词缩写，则单词缩写的每个字母均应大写。
|
类 |
描述 |
示例 |
|
Activity 类 |
Activity为后缀标识 |
欢迎页面类WelcomeActivity |
|
Adapter类 |
Adapte 为后缀标识 |
新闻详情适配器NewDetailAdapter |
|
解析类 |
Data为整体后缀标识，二层析类Bean为后缀标识，三层为Entity。 |
首页解析类HomePosterData |
|
公共方法类 |
Utils、Tools或Manager为后缀标识（灵活运用） |
线程池管理类：ThreadPoolManager 日志工具类：旗鱼点餐中为L |
|
Service类 |
以Service为后缀标识 |
时间服务TimeService |
|
BroadcastReceive类 |
以Receiver为后缀标识 |
时间通知TimeReceiver |
|
ContentProvider |
以Provider为后缀标识 |
时间共享TimeProvider |
|
直接写的共享基础类 |
以Base开头 |
BaseActivity,BaseFragment |
|
............ |
............ |
............. |
2.3 方法（methods）
动词或动名词，采用小驼峰命名法例如:onCreate(),run()。自定义方法定义为private ，特别需要例外。
|
方法 |
说明 |
|
initXX() |
初始化相关方法,使用init为前缀标识，如初始化布局initView() |
|
isXX() |
checkXX()方法返回值为boolean型的请使用is或check为前缀标识，有时必须以get开头，如数据库类里。 |
|
getXX() |
返回某个值的方法，使用get为前缀标识 |
|
processXX() |
对数据进行处理的方法，尽量使用process为前缀标识 |
|
displayXX() |
弹出提示框和提示信息，使用display为前缀标识 |
|
saveXX() |
与保存数据相关的，使用save为前缀标识 |
|
resetXX() |
对数据重组的，使用reset前缀标识 |
|
clearXX() |
清除数据相关的 |
|
removeXXX() |
清除数据相关的 |
|
drawXXX() |
绘制数据或效果相关的，使用draw前缀标识 |
|
initXX() |
初始化相关方法,使用init为前缀标识，如初始化布局initView() |
|
.......... |
..................... |
2.4 变量（variables）
移动Android开发-规范文档