【软件开发规范六】《Android开发编码规范》

简介: 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;

暂时先写这些,后面补上,我写的不是标准规范,大家都可以自己制定一套 适合自己团队用的规范。只要通俗易懂,让别人一眼看上去整个项目不乱就可以。

相关文章
|
18天前
|
Java Android开发
Android 开发获取通知栏权限时会出现两个应用图标
Android 开发获取通知栏权限时会出现两个应用图标
12 0
|
1月前
|
XML 缓存 Android开发
Android开发,使用kotlin学习多媒体功能(详细)
Android开发,使用kotlin学习多媒体功能(详细)
91 0
|
2月前
|
Android开发
安卓SO层开发 -- 编译指定平台的SO文件
安卓SO层开发 -- 编译指定平台的SO文件
29 0
|
1月前
|
设计模式 人工智能 开发工具
安卓应用开发:构建未来移动体验
【2月更文挑战第17天】 随着智能手机的普及和移动互联网技术的不断进步,安卓应用开发已成为一个热门领域。本文将深入探讨安卓平台的应用开发流程、关键技术以及未来发展趋势。通过分析安卓系统的架构、开发工具和框架,本文旨在为开发者提供全面的技术指导,帮助他们构建高效、创新的移动应用,以满足不断变化的市场需求。
18 1
|
3月前
|
Android开发 开发者 iOS开发
APP开发后如何上架,上架Android应用市场前要准备什么
移动应用程序(APP)的开发已经成为现代企业和开发者的常见实践。然而,开发一个成功的APP只是第一步,将其上架到应用商店让用户下载和使用是实现其潜力的关键一步。
|
1月前
|
机器学习/深度学习 调度 Android开发
安卓应用开发:打造高效通知管理系统
【2月更文挑战第14天】 在移动操作系统中,通知管理是影响用户体验的关键因素之一。本文将探讨如何在安卓平台上构建一个高效的通知管理系统,包括服务、频道和通知的优化策略。我们将讨论最新的安卓开发工具和技术,以及如何通过这些工具提高通知的可见性和用户互动性,同时确保不会对用户造成干扰。
31 1
|
9天前
|
XML 开发工具 Android开发
构建高效的安卓应用:使用Jetpack Compose优化UI开发
【4月更文挑战第7天】 随着Android开发不断进化,开发者面临着提高应用性能与简化UI构建流程的双重挑战。本文将探讨如何使用Jetpack Compose这一现代UI工具包来优化安卓应用的开发流程,并提升用户界面的流畅性与一致性。通过介绍Jetpack Compose的核心概念、与传统方法的区别以及实际集成步骤,我们旨在提供一种高效且可靠的解决方案,以帮助开发者构建响应迅速且用户体验优良的安卓应用。
|
18天前
|
Android开发
Android开发小技巧:怎样在 textview 前面加上一个小图标。
Android开发小技巧:怎样在 textview 前面加上一个小图标。
10 0
|
18天前
|
Android开发
Android 开发 pickerview 自定义选择器
Android 开发 pickerview 自定义选择器
10 0
|
24天前
|
Java Android开发
Android开发系列全套课程
本系列课程面向有java基础,想进入企业从事android开发的计算机专业者。学习搭配实战案例,高效掌握岗位知识。
16 1