Android 命名规范和编码规范
2016-02-25 18:51
260 查看
1) Java类文件命名规范。
》Activity 命名规范:以Activity作为后缀。比如说PersionActivity。
》Adapter 命名规范:以Adapter作为后缀。比如说PersionAdapter。
》以Entity 命名规范:以Entity作为后缀。比如说PersionEntity。需要注意的,User是全局变量不是实体,不受此约束。
2).资源文件命名规范。
2.1) layout目录下的文件命名规范
》页面布局文件。以act_为前缀,以Activity所在的Package作为中缀,以Activity的名称(去掉Activity后缀)作为后缀。注意都是小写。例如,对于 Persion 这个模块下的 AddCustomerActivity,它的 layout 文件就应该是:act_persion_addcustomer.xml。
》 ListView 中的 item布局文件。以 item_作为固定前缀,列表项的名称作为后缀。注意都是小写。例如,某个页面下有一个用户列表,控件名为 lvUserList,那么 item 的 layout 就应该是:item_lvUserList.xml。
》 Dialog 布局文件。以 dlg_ 作为固定前缀,Dialog的功能名称为后缀。注意都是小写,例如:dlg_hint.xml。
2.2) drawable 目录下文件命名规范。drawable 目录下的资源,大部分是图片,此外,还有一部分的 xml 文件,用于 Selector。但无论是图片,亦或 Selector 文件,都应该遵守下述命名规范:
》对于只在一个页面使用的资源,就以该页面的名称作为前缀。
》对于只在一个模块下多个页面使用的资源,就以该模块的名称作为前缀。
》对于在各个模块,各个页面都有可能使用的资源,比如说上导航、下导航、以 common 作为前缀。
3) Java 类中控件对象的命名规范。
控件类型缩写 + 控件逻辑名称(首字母大写),比如登录按钮,就可以命名为 btnLogin。
以下列出了一些常用控件的缩写。
LayoutView--lv
RelativeView--rv TextView--tvButton--btnImageButton--imgImageView--ivCheckBox--chkRadioButton--rbDatePicker--dp
EditText--et
4) Layout 中控件对象的命名规范。
与Activity 中相对应的控件名称保持一致。这样的好处是可以迅速 copy-paste出一下代码而杜绝任何潜在的错误:
---(待整理)
5) strings.xml 中常量的命名规范。
因为这些值大多在 Layout 中的控件上使用,所以该常量所在 Activity 名称作为前缀,后面接控件名称,再后面就自由发挥了,比如登录页面的登录按钮上显示的文字,就可以命名为:loginActivity_btnLogin_text。
另外一种场景则是在Java代码使用,可能出现在 Activity 中,也可能出现在工具类Utils中,这时候,如果是和具体的Activity相关,那么规则和上面的一样,以所在的Activity名称作为前缀,如果涉及和公共模块和控件相关,就以common_作为前缀。
strings.xml 的规则可以灵活一些。我们甚至可以将其按照模块拆分为多个 strings.xml 文件,只要 resource标签下都是string 标签就行,编译打包时会自动将同类文件进行合并,例如:strings_module_a.xml、strings_module_b.xml
这样做的好处是,个个模块维护各自的strings.xml。但为常量命名时就一定要以模块名作为前缀了,不然很容易产生重名的情况,从而编译报错。
6)常量命名。
这一点遵守Java的命名规范,即只能包含字母和下划线_,字母全部大写,单词之间用下划线_隔开。
》Activity 命名规范:以Activity作为后缀。比如说PersionActivity。
》Adapter 命名规范:以Adapter作为后缀。比如说PersionAdapter。
》以Entity 命名规范:以Entity作为后缀。比如说PersionEntity。需要注意的,User是全局变量不是实体,不受此约束。
2).资源文件命名规范。
2.1) layout目录下的文件命名规范
》页面布局文件。以act_为前缀,以Activity所在的Package作为中缀,以Activity的名称(去掉Activity后缀)作为后缀。注意都是小写。例如,对于 Persion 这个模块下的 AddCustomerActivity,它的 layout 文件就应该是:act_persion_addcustomer.xml。
》 ListView 中的 item布局文件。以 item_作为固定前缀,列表项的名称作为后缀。注意都是小写。例如,某个页面下有一个用户列表,控件名为 lvUserList,那么 item 的 layout 就应该是:item_lvUserList.xml。
》 Dialog 布局文件。以 dlg_ 作为固定前缀,Dialog的功能名称为后缀。注意都是小写,例如:dlg_hint.xml。
2.2) drawable 目录下文件命名规范。drawable 目录下的资源,大部分是图片,此外,还有一部分的 xml 文件,用于 Selector。但无论是图片,亦或 Selector 文件,都应该遵守下述命名规范:
》对于只在一个页面使用的资源,就以该页面的名称作为前缀。
》对于只在一个模块下多个页面使用的资源,就以该模块的名称作为前缀。
》对于在各个模块,各个页面都有可能使用的资源,比如说上导航、下导航、以 common 作为前缀。
3) Java 类中控件对象的命名规范。
控件类型缩写 + 控件逻辑名称(首字母大写),比如登录按钮,就可以命名为 btnLogin。
以下列出了一些常用控件的缩写。
LayoutView--lv
RelativeView--rv TextView--tvButton--btnImageButton--imgImageView--ivCheckBox--chkRadioButton--rbDatePicker--dp
EditText--et
4) Layout 中控件对象的命名规范。
与Activity 中相对应的控件名称保持一致。这样的好处是可以迅速 copy-paste出一下代码而杜绝任何潜在的错误:
---(待整理)
5) strings.xml 中常量的命名规范。
因为这些值大多在 Layout 中的控件上使用,所以该常量所在 Activity 名称作为前缀,后面接控件名称,再后面就自由发挥了,比如登录页面的登录按钮上显示的文字,就可以命名为:loginActivity_btnLogin_text。
另外一种场景则是在Java代码使用,可能出现在 Activity 中,也可能出现在工具类Utils中,这时候,如果是和具体的Activity相关,那么规则和上面的一样,以所在的Activity名称作为前缀,如果涉及和公共模块和控件相关,就以common_作为前缀。
strings.xml 的规则可以灵活一些。我们甚至可以将其按照模块拆分为多个 strings.xml 文件,只要 resource标签下都是string 标签就行,编译打包时会自动将同类文件进行合并,例如:strings_module_a.xml、strings_module_b.xml
这样做的好处是,个个模块维护各自的strings.xml。但为常量命名时就一定要以模块名作为前缀了,不然很容易产生重名的情况,从而编译报错。
6)常量命名。
这一点遵守Java的命名规范,即只能包含字母和下划线_,字母全部大写,单词之间用下划线_隔开。
相关文章推荐
- android studio 去掉无用资源
- Android 开发中遇到的坑
- Android Studio快速插入模板代码
- 图解Android - Zygote, System Server 启动分析
- 【Android】 解决listview和BaseAdapter配合因加入button导致整个item点击失效
- Android 6.0 运行时权限处理完全解析
- Android 环信的使用
- Android的IPC机制(四)—— Messenger的使用及源码分析
- android 自定义permission的说明
- android常驻通知栏
- android强制为全屏,横屏,竖屏,取消强制横竖屏
- android SharedPreferences 多进程间数据共享
- android中的AIDL学习笔记
- Android客户端内置内存工具进行崩溃定位的实践经验
- 推荐提升 Android 性能的建议
- Android平台类加载流程源码分析
- Android_通过ContentObserver监听短信数据变化
- Android开发环境搭建
- Android 如何修改jar文件
- Android添加系统service