目录
命名规范
- 方法
- 变量
- 类
- 文件
- 常量
注释
命名规范
方法
动词或动名词,采用小驼峰命名法例如:onCreate(),run()
如:
initXX() 初始化相关方法,使用init为前缀标识,如初始化布局initView()
isXX() checkXX()方法返回值为boolean型的请使用is或check为前缀标识
getXX() 返回某个值的方法,使用get为前缀标识
processXX() 对数据进行处理的方法,尽量使用process为前缀标识
displayXX() 弹出提示框和提示信息,使用display为前缀标识
saveXX() 与保存数据相关的,使用sav为e前缀标识
resetXX() 对数据重组的,使用reset前缀标识
clearXX() 清除数据相关的
removeXXX() 清除数据相关的
drawXXX() 绘制数据或效果相关的,使用draw前缀标识变量
Camel 标记法:首字母是小写的,接下来的单词都以大写字母开头
引用布局文件控件命名如:mView 都使用Android Studio JakeWharton 的butterknife帮我们的生成控件命名 点击这里查看butterknife工具操作类
类名通常以大写字母开头,如果类名称由多个单词组成,则每个单词的首字母均应为大 写例如TestPage;如果类名称中包含单词缩写,则这个所写词的每个字母均应大写.
如:XMLExample,还有一点命名技巧就是由于类是设计用来 代表对象的,所以在命名类时应尽量选择名词。文件
资源布局文件(XML文件(layout布局文件)):
全部小写,采用下划线命名法
1). Activity默认布局,以去掉后缀的Activity类进行命名。不加后缀:
功能模块.xml
例如:main.xml、more.xml、settings.xml
或则:act_功能模块.xml
例如:act_main.xml、act_more.xml
2).Dialog命名:dialog_描述.xml
例如:dlg_hint.xml
2).PopupWindow命名:ppw_描述.xml
例如:ppw _info.xml
3). 列表项命名listitem_描述.xml
例如:listitem_city.xml
4).包含项:include_模块.xml
例如:include_head.xml、include_bottom.xml
5).adapter的子布局:adp_功能模块_item.xml
例如:adp _main_item.xml常量
常量的名字应该都使用大写字母,并且指出该常量完整含义。如果一个常量名称由多个单词组成,则应该用下划线来分割这些单词
如:MAX_VALUE
注释
1.文件头注释
每一个文件的文件头都必须做文件头注释。文件头注释范例如下:
/*
* 文件名:LoginActivity
* 描 述:对用户
* 作 者:
* 时 间:
* 版 权:
*/
2.方法头注释
每一个成员方法(包括自定义成员方法、覆盖方法、属性方法)的方法头都必须做方法头注释。
自定义成员方法注释范例如下:
/*
* 方法名:login_Click(View v)
* 功 能:单击登录按钮的事件
* 参 数:View v - 按钮的View
* 返回值:无
*/
3.块注释
在实现一段阶段性功能的代码前做块注释。块注释的注释范例如下:
4.变量注释
所有的成员变量和大多数局部变量在声明时都需要为其做功能注释。
成员变量注释的注释范例如下:
局部变量注释的注释范例如下:
5.语句注释
在关键语句的右侧要做单条语句注释。
语句注释的注释范例如下:
6.有关注释的其它说明
(1) 文件头和方法头注释应该使用//形式,变量注释和语句注释应该使用//形式,块注释应尽量使用//形式,当文字较长(单屏横向不能显示完全)时块注释也可以使用//形式;
(2) 注释量必须不少于代码总量的三分之一;