【软件开发规范六】《Android开发编码规范》
目录
一.工程包命名
二.类文件命名
三. 图片等资源文件命名
四.程序中变量 常量命名
一.工程包命名
工程包名
com. 公司名称简写.应用名称简写(拼音或者英文).activity 放工程的主Activity 以及BaseActivity
com. 公司名称简写.应用名称简写(拼音或者英文).activity.list 在activity下面建一个文件夹list放所有的ListActivity
com. 公司名称简写.应用名称简写(拼音或者英文).adapter 放和主activity对应的adapter 以及通用adapter
com. 公司名称简写.应用名称简写(拼音或者英文).adapter.item 放和listAcitivity对应的Adapter
com. 公司名称简写.应用名称简写(拼音或者英文).bean 放javabean类
com. 公司名称简写.应用名称简写(拼音或者英文).util 放各种工具类 (图片,字符,时间,dalog 等)
com. 公司名称简写.应用名称简写(拼音或者英文).net 放和服务器交互的类
com. 公司名称简写.应用名称简写(拼音或者英文).view 放 自定义view的类
com. 公司名称简写.应用名称简写(拼音或者英文).db 放 本地数据库操作相关的类
当然 上面的公司名称可以换成别的 ,尽量用简写或者英文 比如qq: 就可以写成 com.tencent.qq.activity,大家明白这个意思就好。
二.类文件命名
1. activity
activity 我习惯分为两种考虑, 一种是列表数据的, 第二种是普通的activity 。这么分有个好处就是找这个类的时候方便。当你看到这个界面时列表数据的时候 直接搜索listActivity就能过滤掉一大部分,然后再筛选会简单很多。这个大家从上面我定义的包名中就看出来了。
所以 activity的命名是 : 功能简写+Activity
功能简写+ListActivity
登录:LoginActivity
用户列表:UserListActivity
2. layout xml
全部小写,用_隔开 xml命名 分为几种
主Activity用到的xml : activity_activity名称简写.xml activity_login.xml
include的xml:include_功能简写.xml include_top_search.xml
adapter中用到的xml:item_adapter名称简写.xml item_user_list.xml
dialog用到的xml:dialog_功能简写.xml dialog_show_tips.xml
自定义view用的xml :view_view名称简写.xmlview_header.xml 这个就是共用的view 也可以用common_view名称简写.xml替换
附加:xml中 控件id命名
模块名称_view的逻辑名称_view缩写
用户名EditText : login_username_et
登录确认Button: login_confirm_btn
LayoutView lv RelativeView rv EditText et TextView tv Button btn ImageButton imgBtn ImageView iv CheckBox cbx RadioButton rbtn
其他的类似 不一一列举 这些都不是规定死的 ,大家自己定义,前提能区分开不同的控件并且能让别人看懂。
3.工具类等
工具类功能简写+Util : DialogUtil.java 、 TextUtil.java
三. 图片等资源文件命名
背景图片: bg_功能_说明 bg_login_commit 图标图片: icon_功能_说明 icon_tab_set
功能也可以换为 acvitiy名称简写
共用的图片 前面都加 common
四.程序中变量 常量命名
在说这个之前要给大家补充一下 标识符命名。就是变量和常量名字
我一般就用两种:
1 驼峰(Camel)命名法:又称小驼峰命名法,除首单词外,其余所有单词的第一个字母大写。 protected TextView mWatchCountInfoTv; protected TextView mNicknameTv; protected TextView mLocationTv; protected TextView mVideoTopicTv; protected TextView mVideoTitleTv; 2.下划线命名法:单词与单词间用下划线做间隔。
private static final int MSG_SHOW_GIFT = 20; private static final int MSG_SHOW_EXPRESSION = 21; private static final int MSG_SHOW_RED_PACK = 22; private static final int MSG_SHOW_JOIN_USER = 23;
1. 静态常量
名称都是 功能说明_类别 统一下划线命名法
private static final int MSG_SHOW_GIFT = 20; private static final int MSG_SHOW_EXPRESSION = 21; private static final int MSG_SHOW_RED_PACK = 22; private static final int MSG_SHOW_JOIN_USER = 23;
2.变量
这个分为两种 全局变量 还是 局部变量
全局变量 以m开头,局部变量不用。
全局变量:
protected VideoEntity mCurrentVideo; protected int mShareType; protected MyHandler mHandler; protected int mLikeCount; protected int mCommentCount;
局部变量:
TextView tview = new TextView();
Button button = new Button();
上面已经介绍过 xml中id命名的方法了
所以变量和那个规则基本一致: 功能逻辑名称简写+view 简写
private ImageView mPhoneVerifyIv; private Button mConfirmBtn; private EditText mPhoneNumberEt; private TextView mSelectCountryNameTv; private TextView mSelectCountryCodeTv;
暂时先写这些,后面补上,我写的不是标准规范,大家都可以自己制定一套 适合自己团队用的规范。只要通俗易懂,让别人一眼看上去整个项目不乱就可以。
相关文章
- Android 11 开发者常见问题: 存储 | FAQ・第二期
- android scaleanimation动画,【Android动画九章】-RotateAnimation(旋转动画)和ScaleAnimation(尺寸动画)…[通俗易懂]
- android onresume函数,Android界面跳转时候onDestroy和onResume的调用顺序
- 加密狗android,Android系统加密狗的设计与实现
- android 浏览器 开发,Android 浏览器的开发实例分享
- android图片资源加密,Android平台图像文件加密
- android签名命令行,Android系统签名位置及命令
- Android代码混淆及反编译
- Android平台GB28181设备接入端对接编码前后音视频源类型浅析
- Android 加载串口通信读取信息时 AndroidStudio loadLibrary失败「建议收藏」
- android sdk安装过程,图文详解Android 3.0 SDK安装教程
- android触摸屏事件,Android Touch事件分析
- android登录注册跳转的代码_Android开发代码
- Android 编译_android线程
- android activitymanager 系统api_Android view
- android attrs获取_关于Android attrs 自定义属性的说明
- Android resource linking failed_android sdk location should not
- 深入Android Runtime:并发复制GC
- android 系统浏览器 源码-Android 最最最简单的浏览器代码
- android 国际区号注册手机号编码 以及常用城市列表
- android 跳转第三方地图(百度,高德,谷歌)
- 【Android 属性动画】属性动画 Property Animation 简介 ( 属性动画简介 | 属性动画特性 )
- 【Android RTMP】RTMP 直播推流阶段总结 ( 服务器端搭建 | Android 手机端编码推流 | 电脑端观看直播 | 服务器状态查看 )
- 【Android 高性能音频】Oboe 开发流程 ( Oboe 完整代码示例 )
- 【错误记录】Android Studio 编译报错 ( Could not find com.android.tools.build:gradle:4.2.1. )
- 【Android 逆向】使用 Python 解析 ELF 文件 ( Capstone 反汇编 ELF 文件中的机器码数据 | 反汇编二进制机器码 | 打印反汇编数据 )
- 【错误记录】记录 Android 命令行执行 Java 程序中出现的错误 ( dx 打包 PC 可执行文件报错 | dalvik 命令执行 kotlin 编译的 dex 文件报错 )
- 【Android 命令行工具】Android 命令行工具简介 ( 官方文档 | SDK 命令行工具 | SDK 构建工具 | SDK 平台工具 | 模拟器工具 | Jetifier 工具 )
- 【错误记录】未安装该应用 ( 在 Android 12 之后 组件设置 android:exported=“false“ 属性 )
- Android Studio配置Kotlin环境详解手机开发
- Android Studio 导入项目 出现安装Error:Cause: failed to find target with hash string ‘android-23’ 等错误详解手机开发
- Android Things是什么?
- Android获取经纬度计算距离介绍
- Android中的jQuery:AQuery简介
- Android触屏测试实例代码
- 使用adb命令向Android模拟器中导入通讯录联系人的方法