框架命名规范 - XiongDiHui/YuanDaiMa GitHub Wiki
2.1. 布局文件中的id命名
规则:使用驼峰命名,前缀+逻辑名称,类变量名和布局文件id名称保持一致,不需要下划线分割
控件 缩写前缀
java TextView/EditText mTv + 功能名称
ImageView mImg + 功能名称
Button/RadioButton/ImageButton mBtn + 功能名称
RelativeLayout/LinearLayout/FrameLayout mLayout + 功能名称
ListView mListView
WebView mWebView
CheckBox mCheckBox
ProgressBar mProgressBar
seekBar mSeekBar
MyImageView mViewImg(自定义view)
其他控件 控件名首字母缩写作为前缀
如:TextView @+id/tv_功能名称
如:EditView @+id/et_功能名称
如:Button @+id/btn_功能名称
如:ImageView @+id/iv_功能名称
如:(自定义view)MyImageView @+id/view_功能名称
自定义view以view开头
2.2. 布局文件命名
规则: 使用前缀_逻辑名称命名,单词全部小写,单词间以 下划线 分割。
布局类型 布局前缀
Activity activity_
Fragment frag_
Include include_
Dialog dialog_
PopupWindow popup_
Menu menu_
Adapter layout_item_
listview、gridview等 item_
资源文件命名
规则: 使用 前缀_用途 命名,单词全部小写,单词间以 下划线 分割。
图片资源文件命名
前缀 说明
bg_xxx 各类背景图片
btn_xxx 这种按钮没有其他状态
icon_xxx 图标,一般用于单个图标
bg_描述_状态1[_状态2] 用于控件上的不同状态
btn_描述_状态1[_状态2] 用于按钮上的不同状态
chx_描述_状态1[_状态2] 选择框,一般有2态和4态
第三方资源文件,不管在value、drawable
必须携带第三方资源前缀
umeng_socialize_style.xml
pull_refresh_attrs.xml
2.4. 类和接口命名
规则: 使用驼峰规则,首字母必须大写,使用名词或名词词组。要求简单易懂,富于描述,不允许出现无意义或错误单词。
类 描述 例如
Application类 Application为后缀标识 XXXApplication
Activity类 Activity为后缀标识 闪屏页面类SplashActivity
解析类 Handler为后缀标识
公共方法类 Utils或Manager为后缀标识 (如:StringUtils、LogUtils等)
线程池管理类 ThreadPoolManager
日志工具类 LogUtils
数据库类 以DBHelper后缀标识 MySQLiteDBHelper
Service类 以Service为后缀标识 播放服务:PlayService
BroadcastReceiver类 以Broadcast为后缀标识 时间通知:TimeBroadcast
ContentProvider类 以Provider为后缀标识 单词内容提供者:DictProvider
直接写的共享基础类 以Base为前缀 BaseActivity,BaseFragment
2.5. 方法的命名
规则: 使用驼峰规则,首字母必须小写,使用动词。要求简单易懂,富于描述,不允许出现无意义或错误单词。
方法 说明
initXX() 初始化相关方法,使用init为前缀标识,如初始化布局initView()
httpXX() http业务请求方法,以http为前缀标识
getXX() 返回某个值的方法,使用get为前缀标识
saveXX() 与保存数据相关的,使用save为前缀标识
deleteXX() 删除操作
resetXX() 对数据重组的,使用reset前缀标识
clearXX() 清除数据相关的
isXX() 方法返回值为boolean型的请使用is或check为前缀标识
processXX() 对数据进行处理的方法,尽量使用process为前缀标识
displayXX() 弹出提示框和提示信息,使用display为前缀标识
drawXXX() 绘制数据或效果相关的,使用draw前缀标识
2.6. 变量命名
规则: 使用驼峰规则,首字母必须小写,使用名词或名词词组。要求简单易懂,富于描述,不允许出现无意义或错误单词。
成员变量命名,自定义变量前添加m前缀,布局控件变量不用添加m前缀 常量命名,全部大写,单词间用下划线隔开
3. 其他规范
Activity继承BaseFragmentActivity或SwipeBackActivity,可以使用ButterKnife注解代替findViewById
方法
拆分臃肿方法,每个方法只作一件事
做同一个逻辑的方法,尽量靠近放到一块,方便查看
不要使用 try catch 处理业务逻辑
使用JSON工具类,不要手动解析和拼装数据
控制语句
减少条件嵌套,不要超过3层
if判断使用“卫语句”,减少层级
if(obj != null) { doSomething(); }
修改为:
if(obj == null) { return; } doSomething();
if语句必须用{}包括起来,即便是只有一句
处理“魔数”等看不懂的神秘数字
代码中不要出现数字,特别是一些标识不同类型的数字。
所有意义数字全部抽取到Constant公共类中,避免散布在各位类中。
空行:空行将逻辑相关代码段隔开,简洁清楚,提高可读性
成员变量之间,根据业务形成分组加空行
方法之间加空行
用好TODO标记
记录想法,记录功能点,开发过程中可以利用TODO记录一下临时想法或为了不打扰思路留下待完善的说明
删除无用TODO,开发工具自动生成的TODO,或则已经完善的TODO,一定要删除。