Android项目命名规则.doc
Android文件命名规范初版
指定日期: 2014年1月10日 工作组 Android
注:
为了项目更好的协同工作,以及项目的版本维护,Android组采用以下标准来命名项目的文件;
一 代码命名规则:
1 final类型变量、枚举 均采用全大写形式
2控件名称采用与资源ID相同的形式统一采用全小写; 例如资源中有一个 Button id为btn_login_sure 其在Activity中的映射也为属性名也应为 btn_login_sure
3 总体使用驼峰命名方式(类名首字母大写,方法与属性首字母小写,第1.2条除外)
例如: User 类中 有一个属性 userName 一个方法 setUserName
4 继承自Android组件的类,采用 父类名称作为结尾的形式
例如: LoginActivity MstarcImageView BaseFragment HoldService
5 测试用数据或者类,均以Test或者test为前缀,且如果不再使用需要删除或用@Deprecated 标记
6 凡涉及框架,或者项目内工具类的 代码,据需采用eclipse标准注释进行注解
7 涉及Javabean的实体类,如需与其他模块保持一致性,可不遵循以上原则
二 资源命名规则:
一 Layout命名
1.contentview命名:activity_功能模块.xml
例如:activity_main.xml、activity_more.xml
2.Dialog命名:dialog_描述_【属性说明】.xml 例如:dlg_hint.xml
2.PopupWindow命名:ppw_描述_【属性说明】.xml 例如:ppw _info_comm.xml
3. 适配器项命名adpter_控件描述_【属性说明】.xml 例如:adepter_list_city.xml
4.包含项:include_模块.xml 例如:include_head.xml、include_bottom.xml
二 图片命名
1. 前缀_模块、前缀_模块_描述、前缀_模块_描述_后缀
例如:bg_mainActivity.png、 icon_btn_sure_left.png、 img_main_logo、 bg_btn_cancel_press.png
三 id命名
空间类型缩写_所在上下文_属性
例如
登陆界面的确定按钮:
btn_loginActivity_ sure
有一个listView,其adpter的id为adpter_list_users.xml
其适配器布局文件中一个CheckBox的命名为
chb_list_users_checksure
三 其他规则:
1 包名 以com.mstarc.app.[项目名].[分组].[分组]的形式 例如安全镯 的service包:com.mstarc.app.anquanzhuo.service
2 命名下划线使用数量一般不能超过4个,总长度不能过长一般为四个单词为宜,长单词可采用缩写
3 凡以上规则未涉及的文件或代码命名,均以简洁,且方便查找为基本原则
图片部分后缀对照表
(静态一般为图片)
后缀说明normal图片按钮等控件的状态,代表普通状态disabled图片按钮等控件的状态,代表不可用press图片按钮等控件的状态,代表按下状态 (动态一般为xml文件 )
后缀说明selector包含了控件的各种状态下对应的资源ainm动画资源 组件名称缩写对照表
组件名称简写组件名称简写ButtonbtnRadioButtonrbtnImageButtonibtnTextViewtvImageViewimgListViewlistProgressBarpbEditTextetScrollViewsvCheckBoxchbRelativeLayoutrlLinearLayoutlyTableLayouttlAbsoluteLayoutabFrameLayouttl