android开发简单规范

 

本博客借鉴及删减了Jacky_WK的博客文章

  https://blog.csdn.net/wangkuan219/article/details/52576762

本人并无抄袭之意，由于开发任务紧急，又是刚组的团队，所以临时修改了部分内容供团队使用

1.工具版本：

. jdk 1.8（lambda表达式）

. android studio 使用3.1.3版本studio工具。

. gradle 使用版本为 gradle-4.4-all.zip。

. 统一使用svn进行开发。

2.编码方式： utf-8

3.命名规范

类	命名格式	示例
Activity	A_xxx功能	如：首页A_Home，启动页：A_Launcher
Fragment	F_xxx功能	如：显示个人信息的Fragment，F_PersonalInfo
Service	S_xxx功能	如：下载的Service，S_Download
ContentProvider	P_xxx功能	如：联系人内容提供者，P_Contacts
BroadcastReceiver	R_xxx功能	如：接受极光推送的广播接收者，R_Jupsh
Adapter	xxx_功能+xx类型控件Adapter	如：信息列表适配器，InfoListAdapter
基础功能类	Base+xx父类名	如：BaseActivity
工具类	xxx_功能+Utils	如：ToastUtils
管理类	xxx_功能+Manager	如：HttpManager

4.接口类命名都已I+xxx功能，如：IShare

5.方法命名

 

命名方式	含义
initXXX()	初始化，初始化控件initView()
isXXX()	是否满足某种条件，isLogin()
processXXX()	对某些数据进行处理，processListData()
showXXX()	显示信息，showToast() , showDialog()
saveXXX()	保存数据，savePersonInfo()
addXXX()或putXXX()	添加数据，addUser()
deleteXXX()或removeXXX()	删除数据，removeUser()
resetXXX()	重置信息，resetInfo()
updateXXX()	更新数据，updateData()
findXXX()或queryXXX	查询数据，findPersonId()

6.关于变量

 

类的变量	示例
成员变量	以m打头：     例如 private Context mContext；
静态变量	以s打头:  例如 private static Context sContext；

7.关于布局文件：

 

类名	布局文件名
A_Home类	布局文件名为小写，如：a_home.xml
F_Home类	布局文件名为小写，如：f_home.xml
RecyclerView的item布局	item布局文件命名为：item_people_info

8.关于常用控件

 

控件	前缀缩写
RelativeLayout	rl_布局文件名_xx
LinearLayout	ll_布局文件名_xx
FrameLayout	fl_布局文件名_xx
TextView	tv_布局文件名_xx
Button	bt_布局文件名_xx
ImageView	iv_布局文件名_xx
EditText	et_布局文件名_xx
ListView	lv_布局文件名_xx
GridView	gv_布局文件名_xx
RecyclerView	rv_布局文件名_xx
RadioGroup	rg_布局文件名_xx
RadioButton	rb_布局文件名_xx
ToggleButton	tb_布局文件名_xx
ImageButton	ib_布局文件名_xx

9.关于shape，selector等xml布局文件，要以shape_xxx  格式，selector_xxx格式

10.每个类的类名称上一行都要写有 相关信息：如下图（可以在studio中进行模板配置）

/**
 * 项目-正在进行的项目
 * 作者：Laughing on 2018/5/3 20:37
 * 邮箱：719240226@qq.com
 */

public class A_Project_Doing extends TitleActivity implements ProjectDoingView<List<ProjectDoingRep>> {
      ......................................
}

11.方法注释 实例如下：

 

/**
 * 第一次加载数据或者下拉刷新
 *
 * @param projectDoingReps
 */
public void initDataResult(List<ProjectDoingRep> projectDoingReps) {
    mBinding.srlProjectDoing.setRefreshing(false);
    mAdapter.setData(projectDoingReps);
}