命名的规范可以提高代码的易读性和一致性,为了更好的编程习惯,让我们一起来执行吧~
变量
- 全局变量
建议以m开头
//非控件 m+功能+数据结构
private List<Fragment> mFragmentList;
//控件 m+控件+描述;
private TextView mTvName;
- 静态变量
建议以s开头
private static String sName;
常量
全部大写,采用下划线命名法
private static final int EXIT_TIME = 2000;
方法
动词或动名词命名法
初始化相关方法,使用init为前缀标识,如:初始化布局initView();
boolean型使用is或check为前缀标识, 如:checkValue()、isValidate();
返回某个值的方法,使用get为前缀标识,如:getName();
数据进行处理相关,尽量使用process为前缀标识,如:processUpdate();
保存数据相关,使用save为前缀标识,如:saveData();
对数据重置的,使用reset前缀标识,如:resetData();
清除数据相关,使用clear前缀标识,如:clearData();
移除某些项目,使用remove前缀标识,如:removeItem();
绘制数据或效果相关的,使用draw前缀标识,如:drawCircle();
Drawable资源
前缀-功能-模块-说明.xml/png
说明 | 命名示例 |
---|---|
图标:建议格式ic_××× | ic_lanucher.png |
背景:建议格式bg_××× | bg_normal_button_default.png |
Layout 资源文件
类型-模块-功能-说明.xml
说明 | 命名示例 |
---|---|
Activity布局文件 | activity_main.xml |
Fragment布局文件 | fragment_main.xml |
自定义提示对话框 | dialog_alert.xml |
列表项 | item_main_.xml item-模块-功能 |
include | include-.xml include-功能 |
Layout 资源Id
控件-模块-说明
说明 | 命名示例 |
---|---|
TextView | @id/tv_main_name |
ListView | @id/lv_find_citylist |
动画Anim文件
描述-动画-方向.xml
说明 | 命名示例 |
---|---|
淡入 | anim_fade_in.xml |
淡出 | anim_fade_out.xml |
Color资源文件
非透明:颜色+16进制前两位缩写
<color name="gray_98">#989898</color>
透明:tran-颜色-透明度 透明度参考
<color name="tran_gray_10">#1A989898</color>
欢迎一起讨论、指正和补充~
补充一个AndroidStudio的规范化开发插件CheckStyle,详见 AndroidStudio 配置 CheckStyle~