网上的命名规范各式各样,跟自己的风格不太一致,做个记录,自己的开发规范与习惯
1、包命名
- base: 存放基础类的包,里面的类以
Base
为前缀,例如BaseActivity
; - activity: 存放 activity 的包,每个 activity 命名以Activity结尾,例如
MainActivity
; - fragment: 存放 fragment的包,每个 fragment 命名以 Fragment 结尾,例如
ChatFragment
; - receiver: 存放 receiver 的包;
- service: 存放 service 的包;
- adapter: 存放 adapter 的包,每个 adapter 命名以 Adapter 结尾,例如
EventItemAdapter
; - common: 存放一些公共常量,例如后端接口、
SharedPreferenceKey
、IntentExtra
等; - utils: 存放工具类的包,比如常见的工具类:
LogUtils
、DateUtils
; - entity: 存放实体类的包;
- widget: 存放自定义View的包;
- module:按模块进行分包时,在模块的下面有自己单独的东西再进行1-10的划分;
- 小写字母,参见上文包管理;
- 连续的单词直接连接起来,不使用下划线
大驼峰命名
-
Activity –> xxxActivity.java
-
Application –> xxxApplication.java
-
Fragment –> xxxFragment.java
-
Service –> xxxService.java
-
BroadcastReceiver –> xxxBroReceiver.java
-
ContentProvider –> xxxProvider.java
-
Adapter –> xxxAdapter.java
-
Handler –> xxxHandler.java
-
接口 –> xxxInter.java
-
接口实现类 –> xxxImpl.java
-
Persenter –> xxxPersenter.java
-
公共父类 –> BaseActivity.java、BaseFragment.java、- BaseAdapter.java等
-
util类 –> LogUtil.java
-
数据库类 –> BaseSQLiteDBHelper.java
3、其他命名
常量命名:
单词每个字母均大写;
单词之间下划线连接
变量命名:
小驼峰命名;
例如
tvPostTitle
方法命名:小驼峰命名
控件命名:
建议使用
控件缩写+逻辑名称
格式,例如
tvPostTitle
、
etUserName
;
对应的控件的 id 的命名
控件缩写_逻辑名称
,单词均小写,用下划线连接,例如:
tv_post_title
、
et_user_name
;
常见的控件缩写如下
控件 | 缩写 |
---|---|
Linearlayout | ll |
RelativeLayout | rl |
TextView | tv |
EditText | et |
Button | btn |
ImageView | iv |
CheckBox | chb |
ListView | lv |
GridView | gv |
RadioButton | rb |