Android编程开发规范
       

原文地址 http://www.jianshu.com/p/9b8aeca9b281

一.约定

Activity.onCreate(),Fragment.onActivityCreated(),作为程序入口,不用写入太多代码,尽量保持仅仅调用initXXX()方法,简单明了展示调用过程。如:initData()。initView()。
单个方法体不要过长
代码不论什么地方不要拼错单词
杜绝整个类代码格式化
调用方法保持“临近原则”,被调用的方法,放在调用方法下方
统一调整IDE的Tab缩进为4个空格
空行的使用,拒绝拖沓无切割,关联代码段放一块并与后面代码切割
用好TODO标记
记录想法,记录功能点,开发过程中能够利用TODO记录一下暂时想法或为了不打搅思路留下待完好的说明
删除无用TODO。开发工具自己主动生成的TODO,或则已经完好的TODO,一定要删除。
处理“魔数”等看不懂的神奇数字
代码中不要出现数字。特别是一些标识不同类型的数字。 所有意义数字所有抽取到Constant公共类中,避免散布在各位类中。

二.命名 

1. 布局文件里的id命名

规则:使用驼峰命名。前缀+逻辑名称,类变量名和布局文件id名称保持一致,不须要下划线切割

控件前缀规则:

TextView/EditText: tv/et
Button/RadioButton/ImageButton: btn
ImageView: img
RelativeLayout/LinearLayout/FrameLayout: layout,
ListView: listView
WebView: webView
CheckBox: chBox 如:TextView @+id/tvTitle
如:EditView @+id/etName
如:Button @+id/btnSearch

2.布局文件命名

规则: 使用前缀_逻辑名称命名,单词所有小写,单词间以 下划线 切割。

前缀规则:

Activity相应的布局使用activity_  有时候类名过长 可简写为aty

Fragment相应的布局使用fragment_   简写 fgt

如:PublishActivity: activity_publish.xml   PublishAty 

3.资源文件命名

规则: 使用 前缀_用途 命名,单词所有小写。单词间以 下划线 切割。

drawable:
btn_back_selector.xml 控件前缀命名
common_circle_gray.xml 通用资源多处使用common_
chat_image_selector.xml 功能相关业务使用加用途前缀 drawable_hdpi:
btn_back_normal.9.png 控件前缀名称
btn_back_press.9.png 控件前缀名称
icon_login_lock.png icon_+用途 values/color:
pull_refresh_attrs.xml 引入的第三方资源。携带资源简拼的前缀

4.类和接口命名

规则: 使用驼峰规则,首字母必须大写,使用名词或名词词组。要求简单易懂,富于描写叙述,不同意出现无意义或错误单词。

如:class BookMarkAdd 正确
如:class AddBookReadPlan 错误! 应为 class BookReadPlanAdd

5.方法命名

规则: 使用驼峰规则。首字母必须小写,使用动词。

要求简单易懂。富于描写叙述,不同意出现无意义或错误单词。

如:public void run();
如:public String getBookName();

6.变量命名

规则: 使用驼峰规则,首字母必须小写,使用名词或名词词组。要求简单易懂,富于描写叙述,不同意出现无意义或错误单词。

成员变量命名,不要在私有变量前加入m字样
常量命名。所有大写,单词间用下划线隔开

7.其它

空行:空行将逻辑相关代码段隔开。简洁清楚。提高可读性
成员变量之间,依据业务形成分组加空行
方法之间加空行
控制语句
降低条件嵌套,不要超过3层
if推断使用“卫语句”。降低层级
if(obj != null) { doSomething();}
改动为:
if(obj == null) { return;}doSomething();
if语句必须用{}包含起来,即便是仅仅有一句
方法
拆分臃肿方法,每一个方法仅仅作一件事
做同一个逻辑的方法,尽量靠近放到一块。方便查看
不要使用 try catch 处理业务逻辑
使用JSON工具类,不要手动解析和拼装数据
Activity继承BaseFragmentActivity或SwipeBackActivity,能够使用ButterKnife注解取代findViewById。

三.IDE

Android Studio (越早使用越好)
Android SDK 4.4W (API 20 统一开发版本号)
JDK 1.8(统一开发版本号)

四.Libraries

Base

fastjson-android-1.2.4.jar
okhttp-2.2.0.jar
okio-1.2.0.jar
picasso-2.5.0.jar
butterknife:7.0.1
ormlite-android:4.48
volley

UI

PullToRefresh
QuickAdapter
PagerSlidingTabStrip
SystemBarTint 状态栏以及导航栏设置背景颜色
SwipeBackLayout 左滑返回
PullToZoomView 能够下拉缩放HeaderView
AutoLoopViewPager 轮播图
PhotoView
ViewPageIndicator

Android_编程开发规范的更多相关文章

  1. 我的公司培训讲义(1):.NET开发规范教程

    这是1年多以前我在公司所做讲座的讲义,现在与园友们分享,欢迎拿去使用.一起讨论.文中有若干思考题,对园友们是小菜一碟.另有设计模式讲义一篇,随后发布.博文上了首页,感谢博客园团队推荐,也感谢所有园友的 ...

  2. C#代码开发规范

    Wrod下载           C#代码开发规范     文件状态: [√] 草稿 [  ] 正式 [  ] 修改 文件标识: 当前版本: 1.1 作    者: Empty 联系电话: 最后更新: ...

  3. J2EE开发规范

    J2EE开发规范一 JAVA编码规范1 命名规范1.1 包命名 包名称必须全部用小写. 命名方式:业务领域名.公司名.项目名.模块名 如com.yr.xxx.dao.1.2 类命名类名以英文单词取 ...

  4. PHP开发规范

    十.开发规范下面我们讲解 Yii 编程中推荐的开发规范.为简单起见,我们假设 WebRoot 是 Yii 应用安装的目录.1.URL默认情况下,Yii 识别如下格式的 URL: http://host ...

  5. 【JavaScript 开发规范】

    Javascript 最佳实践http://sofish.de/1171http://sofish.de/1181 总是使用 ‘var’ √ 特性检测而非浏览器检测 √ 使用方括号记法 √ 使用&qu ...

  6. C++编程命名规范

    原地址:http://www.cnblogs.com/joinclear/archive/2013/02/21/2921422.html C++编程命名规范 0前言 根据多年工作经验和其它命名规范整理 ...

  7. .NET开发规范教程

    .NET开发规范教程 这是1年多以前我在公司所做讲座的讲义,现在与园友们分享,欢迎拿去使用.一起讨论.文中有若干思考题,对园友们是小菜一碟.另有设计模式讲义一篇,随后发布. 1 概述 1.1 意义 “ ...

  8. Manual | BSD手册| Linux手册 | 数据库手册 | 编程开发手册 | WEB开发手册 | 软件应用手册 | 网络技术手册 | GNU手册

    豆豆手册 □ BSD手册 □ Linux手册 □ 数据库手册 □ 编程开发手册 □ WEB开发手册 □ 软件应用手册 □ 网络技术手册 □ GNU手册 在线手册 首 页 BSD手册   ·FreeBS ...

  9. 前端开发规范:命名规范、html 规范、css 规范、js 规范

    上周小组的培训内容是代码可读性艺术,主要分享如何命名.如何优化代码排版,如何写好的注释.我们都知道写出优雅的代码是成为大牛的必经之路. 下面感谢一位前端开发小伙伴总结的前端开发规范,通过学习相关开发规 ...

随机推荐

  1. 20165235 祁瑛 2018-4 《Java程序设计》第七周学习总结

    20165235 祁瑛 2018-4 <Java程序设计>第七周学习总结 教材学习内容总结 MySQL数据管理系统 MySQL数据管理系统,简称MySQL,是世界上流行的数据管理系统. M ...

  2. 电信项目java补充类

    一.DecimalFormat 1.概述 public class DecimalFormat extends NumberFormat DecimalFormat是格式为十进制数的NumberFor ...

  3. poj-1287 Networking(Prim)

    题目链接:http://poj.org/problem?id=1287 题目描述: 请先参考关于prim算法求最小生成树的讲解博客:https://www.cnblogs.com/LJHAHA/p/1 ...

  4. Xamarin Essentials教程使用加速度传感器Accelerometer

    Xamarin Essentials教程使用加速度传感器Accelerometer   加速度传感器是一种能够测量加速度的传感器,用于检测设备状态的改变.在Xamarin中,如果开发者想要使用加速度传 ...

  5. Xamarin Essentials教程振动Vibration

    Xamarin Essentials教程振动Vibration   振动是提醒用户的有效方式,尤其是声音提示效果不明显的场景中,如吵杂的环境中,手机放到包中.在很多的游戏中,振动还用来模拟游戏特效,如 ...

  6. SSM项目搭建

    1.新建包 com.javen.controller com.javen.service com.javen.dao com.javen.domain com.javen.mapper 2.log4j ...

  7. 2545 ACM 博客 比较树的路径长短

    题目:http://acm.hdu.edu.cn/showproblem.php?pid=2545 题意:比较树的路径长短 思路:利用数组存入父节点的值, 例如: 5 2 1 2 1 3 3 4 3 ...

  8. MQ基本概念

    MQ的基本概念 1) 队列管理器 队列管理器是MQ系统中最上层的一个概念,由它为我们提供基于队列的消息服务. 2) 消息 在MQ中,我们把应用程序交由MQ传输的数据定义为消息,我们可以定义消息的内容并 ...

  9. NHibernate查询优化的相关资料

    一.http://www.cnblogs.com/dddd218/archive/2009/09/01/1557640.html 1.立即加载(lazy=false)并不能在所有情况下都会减少SQL语 ...

  10. 初次接触Jenkins遇到的几个问题

    1,Jenkins一直显示pending-Waiting for next available executor 网上已经提到的原因 1>,磁盘满了 2>,节点管理 刷新状态 我遇到的情况 ...