Android技术积累:开发规范
转载自Keegan小钢 http://keeganlee.me/post/android/20150709
书写规范
1. 编码方式统一用UTF-8. Android Studio默认已是UTF-8,只要不去改动它就可以了。
2. 缩进统一为4个空格,将Tab size设置为4则可以保证tab键按4个空格缩进。另外,不要勾选上Use tab character,可以保证切换到不同tab长度的环境时还能继续保持统一的4个空格的缩进样式。
3. 花括号不要单独一行,和它前面的代码同一行。而且,花括号与前面的代码之间用一个空格隔开。
public void method() { // Good } public void method()
{ // Bad
} public void method(){ // Bad }
4. 空格的使用
if、else、for、switch、while等逻辑关键字与后面的语句留一个空格隔开。
// Good
if (booleanVariable) {
// TODO while booleanVariable is true
} else {
// TODO else
} // Bad
if(booleanVariable) {
// TODO while booleanVariable is true
}else {
// TODO else
}
运算符两边各用一个空格隔开。
int result = a + b; //Good, = 和 + 两边各用一个空格隔开
int result=a+b; //Bad,=和+两边没用空格隔开
方法的每个参数之间用一个空格隔开。
public void method(String param1, String param2); // Good,param1后面的逗号与String之间隔了一个空格
method(param1, param2); // Good,方法调用时,param1后面的逗号与param2之间隔了一个空格
method(param1,param2); // Bad,没有用一个空格隔开
5. 空行的使用
将逻辑相关的代码段用空行隔开,以提高可读性。空行也只空一行,不要空多行。在以下情况需用一个空行:
- 两个方法之间
- 方法内的两个逻辑段之间
- 方法内的局部变量和方法的第一条逻辑语句之间
- 常量和变量之间
6. 当一个表达式无法容纳在一行内时,可换行显示,另起的新行用8个空格缩进。
someMethod(longExpression1, longExpression2, longExpression3,
longExpression4, longExpression5);
7. 一行声明一个变量,不要一行声明多个变量,这样有利于写注释。
private String param1; // 参数1
private String param2; // 参数2
8. 行宽设置为100,设置格式化时自动断行到行宽位置。
9. 使用快捷键进行代码自动格式化。
Windows:CTRL+ALT+L
Mac:OPTION+COMMAND+L
10. 一个方法最多不要超过40行代码。
11. 范围型的常量用枚举类定义,而不要直接用整型或字符,这样可以减少范围值的有效性检查。
// 用枚举类定义,Good
public enum CouponType {
// 现金券
@SerializedName("1")
CASH, // 抵用券
@SerializedName("2")
DEBIT, // 折扣券
@SerializedName("3")
DISCOUNT
} // 用整型定义,Bad
public static final int TYPE_CASH = 1; // 现金券
public static final int TYPE_DEBIT = 2; // 抵扣券
public static final int TYPE_DISCOUNT = 3; // 折扣券
12. 文字大小的单位统一用sp,元素大小的单位统一用dp。
13. 应用中的字符串统一在strings.xml中定义,然后在代码和布局文件中引用。
14. 颜色值统一在colors.xml中定义,然后在代码和布局文件中引用。另外,不要在代码和布局文件中引用系统的颜色,除了透明。
命名规范
1. 包命名
域名反写+项目名称+模块名称,全部单词用小写字母。
例如,我的KAndroid项目的Model模块包名如下:
me.keeganlee.kandroid.model
2. 类和接口命名
使用大驼峰规则,用名词或名词词组命名,每个单词的首字母大写。
以下为几种常用类的命名:
- activity类,命名以Activity为后缀,如:LoginActivity
- fragment类,命名以Fragment为后缀,如:ShareDialogFragment
- service类,命名以Service为后缀,如:DownloadService
- adapter类,命名以Adapter为后缀,如:CouponListAdapter
- 工具类,命名以Util为后缀,如:EncryptUtil
- 模型类,命名以BO为后缀,如:CouponBO
- 接口实现类,命名以Impl为后缀,如:ApiImpl
3. 方法命名
使用小驼峰规则,用动词命名,第一个单词的首字母小写,其他单词的首字母大写。
以下为几种常用方法的命名:
- 初始化方法,命名以init开头,例:initView
- 按钮点击方法,命名以to开头,例:toLogin
- 设置方法,命名以set开头,例:setData
- 具有返回值的获取方法,命名以get开头,例:getData
- 通过异步加载数据的方法,命名以load开头,例:loadData
- 布尔型的判断方法,命名以is或has,或具有逻辑意义的单词如equals,例:isEmpty
4. 控件缩写
控件 | 缩写 | 控件 | 缩写 |
---|---|---|---|
TextView | txt | EditText | edt |
Button | btn | ImageButton | ibtn |
ImageView | img | ListView | list |
RadioGroup | group | RadioButton | rbtn |
ProgressBar | progress | SeekBar | seek |
CheckBox | chk | Spinner | spinner |
TableLayout | table | TableRow | row |
LinearLayout | llayout | RelativeLayout | rlayout |
ScrollView | scroll | SearchView | search |
TabHost | host | TabWidget | widget |
5. 常量命名
全部为大写单词,单词之间用下划线分开。
public final static int PAGE_SIZE = 20;
6. 变量命名
{范围描述+}意义描述+类型描述的组合,用驼峰式,首字母小写。
private TextView headerTitleTxt; // 标题栏的标题
private Button loginBtn; // 登录按钮
private CouponBO couponBO; // 券实例
7. 控件id命名
控件缩写_{范围_}意义,范围可选,只在有明确定义的范围内才需要加上。
<!-- 这是标题栏的标题 -->
<TextView
android:id="@+id/txt_header_title"
... /> <!-- 这是登录按钮 -->
<Button
android:id="@+id/btn_login"
... />
8. layout命名
组件类型_{范围_}功能,范围可选,只在有明确定义的范围内才需要加上。
以下为几种常用的组件类型命名:
- activity_{范围_}功能,为Activity的命名格式
- fragment_{范围_}功能,为Fragment的命名格式
- dialog_{范围_}功能,为Dialog的命名格式
- item_list_{范围_}功能,为ListView的item命名格式
- item_grid_{范围_}功能,为GridView的item命名格式
- header_list_{范围_}功能,为ListView的HeaderView命名格式
- footer_list_{范围_}功能,为ListView的FooterView命名格式
9. strings的命名
类型_{范围_}功能,范围可选。
以下为几种常用的命名:
- 页面标题,命名格式为:title_页面
- 按钮文字,命名格式为:btn_按钮事件
- 标签文字,命名格式为:label_标签文字
- 选项卡文字,命名格式为:tab_选项卡文字
- 消息框文字,命名格式为:toast_消息
- 编辑框的提示文字,命名格式为:hint_提示信息
- 图片的描述文字,命名格式为:desc_图片文字
- 对话框的文字,命名格式为:dialog_文字
- menu的item文字,命名格式为:action_文字
10. colors的命名
前缀{_控件}{_范围}{_后缀},控件、范围、后缀可选,但控件和范围至少要有一个。
- 背景颜色,添加bg前缀
- 文本颜色,添加text前缀
- 分割线颜色,添加div前缀
- 区分状态时,默认状态的颜色,添加normal后缀
- 区分状态时,按下时的颜色,添加pressed后缀
- 区分状态时,选中时的颜色,添加selected后缀
- 区分状态时,不可用时的颜色,添加disable后缀
11. drawable的命名
前缀{_控件}{_范围}{_后缀},控件、范围、后缀可选,但控件和范围至少要有一个。
- 图标类,添加ic前缀
- 背景类,添加bg前缀
- 分隔类,添加div前缀
- 默认类,添加def前缀
- 区分状态时,默认状态,添加normal后缀
- 区分状态时,按下时的状态,添加pressed后缀
- 区分状态时,选中时的状态,添加selected后缀
- 区分状态时,不可用时的状态,添加disable后缀
- 多种状态的,添加selector后缀(一般为ListView的selector或按钮的selector)
12. 动画文件命名
动画类型_动画方向。
- fade_in,淡入
- fade_out,淡出
- push_down_in,从下方推入
- push_down_out,从下方推出
- slide_in_from_top,从头部滑动进入
- zoom_enter,变形进入
- shrink_to_middle,中间缩小
注释规范
1. 文件头注释
文件顶部统一添加版权声明,声明的格式如下:
/**
* Copyright (c) 2015. Keegan小钢 Inc. All rights reserved.
*/
2. 类和接口注释
类和接口统一添加javadoc注释,格式如下:
/**
* 类或接口的描述信息
*
* @author ${USER}
* @date ${DATE}
*/
3. 方法注释
下面几种方法,都必须添加javadoc注释,说明该方法的用途和参数说明,以及返回值的说明。
- 接口中定义的所有方法
- 抽象类中自定义的抽象方法
- 抽象父类的自定义公用方法
- 工具类的公用方法
/**
* 登录
*
* @param loginName 登录名
* @param password 密码
* @param listener 回调监听器
*/
public void login(String loginName, String password, ActionCallbackListener<Void> listener);
4. 变量和常量注释
下面几种情况下的常量和变量,都要添加注释说明,优先采用右侧//来注释,若注释说明太长则在上方添加注释。
- 接口中定义的所有常量
- 公有类的公有常量
- 枚举类定义的所有枚举常量
- 实体类的所有属性变量
public static final int TYPE_CASH = 1; // 现金券
public static final int TYPE_DEBIT = 2; // 抵扣券
public static final int TYPE_DISCOUNT = 3; // 折扣券 private int id; // 券id
private String name; // 券名称
private String introduce; // 券简介
Android技术积累:开发规范的更多相关文章
- (转)Android技术积累:图片异步加载
当在ListView或GridView中要加载很多图片时,很容易出现滑动时的卡顿现象,以及出现OOM导致FC(Force Close). 会出现卡顿现象主要是因为加载数据慢,要等数据加载完才能显示出来 ...
- (转)Android技术积累:图片缓存管理
如果每次加载同一张图片都要从网络获取,那代价实在太大了.所以同一张图片只要从网络获取一次就够了,然后在本地缓存起来,之后加载同一张图片时就从缓存中加载就可以了.从内存缓存读取图片是最快的,但是因为内存 ...
- 【转】android技术栈
android技术栈-现有使用的进行一个汇总(初稿) 2017年04月24日 16:19:40 阅读数:2004 android技术栈 开发工具 Android studio 开发语言 Java 自动 ...
- 【转】Android开发规范
转自:https://github.com/Blankj/AndroidStandardDevelop 摘要 1 前言 2 AS 规范 3 命名规范 4 代码样式规范 5 资源文件规范 6 版本统一规 ...
- 【转】Android 开发规范(完结版)
摘要 1 前言 2 AS 规范 3 命名规范 4 代码样式规范 5 资源文件规范 6 版本统一规范 7 第三方库规范 8 注释规范 9 测试规范 10 其他的一些规范 1 前言 为了有利于项目维护.增 ...
- Android 你应该注意的开发规范
本文由Blankj投稿. Blankjd的博客地址: http://www.jianshu.com/u/46702d5c6978 为了利于项目维护以及规范开发,促进成员之间Code Review的效率 ...
- 八一八android开发规范(一种建议)
开发规范重不重要了,不言而喻.这里就给大家说一故事把——据<圣经·旧约·创世记>第11章记载,是当时人类联合起来兴建,希望能通往天堂的高塔.为了阻止人类的计划,上帝让人类说不同的语言,使人 ...
- Android 插件化开发(一):Java 反射技术介绍
写在前面:学习插件化开发推荐书籍<Android 插件化开发指南>,本系列博客所整理知识部分内容出自此书. 在之前的项目架构的博文中,我们提到了项目插件化架构,提到插件化架构不得不提的到J ...
- 【敏捷开发】Android团队开发规范
这里说的开发规范分成目录规范,项目和包名的命名规范,类,方法,变量和常量的命名规范这几种. 目录规范 目录规范——在开发中整体文件夹组织结构. Requirement——需求文档文件夹 Design— ...
随机推荐
- ASP.NET MVC 4 (三) 过滤器
先来看看一个例子演示过滤器有什么用: public class AdminController : Controller { // ... instance variables and constru ...
- GridView获取列子段的几种途径
GridView是ASP.NET中功能强大的数据显示控件,它的RowDataBound事件为我们提供了方便的控制行.列数据的途径. 要获取当前行的某个数据列,我在实践中总结有如下几种方法: 1. Ce ...
- TCP Socket 通讯(客户端与服务端)
/*----------------------------编译环境:VS2015---------------------------------------*/ /*--------------- ...
- System.Web.Script.Serialization引用找不到的问题
之前在项目中要使用JavascriptSerializer这个类,需要引入System.Web.Script.Serialization命名空间,但是在添加引用中找不到这个命名空间,后来才得知Syst ...
- 在web.config配置中添加xml内容
在web.config 中添加需要的内容时, 就是在<configuration>节点内添加一个新的<configSections>元素, 在configSections元素中 ...
- std::vector<bool>中的坑
http://www.cplusplus.com/reference/vector/vector/?kw=vector C++中,vector<bool>为了达到节省内存的目的,专门做了特 ...
- [软件架构]模块化编程思想及(C++)实践
Repost 内容简介: 模块化思想 模块的构成 模块的管理 模块化实践 定义模块结构 声明模块对象 定义模块列表 模块列表对象 模块化思想 1. 将系统分成很多的模块,模块内部关注自身需要实 ...
- ie9 placeholder兼容
.phcolor{ color:#999;}//css样式 function isPlaceholer(){ var input = document.createElement("inpu ...
- oracle 行转列、列转行
最近做数据处理,经常遇到需要行转列.列转行的场景,记录个非常简单实用的oracle 列转行.行转的列方法 1.行转列,基础数据如下 做行转列处理 处理SQL select user_name,max ...
- 【搬砖】【Python数据分析】Pycharm中plot绘图不能显示出来
最近在看<Python数据分析>这本书,而自己写代码一直用的是Pycharm,在练习的时候就碰到了plot()绘图不能显示出来的问题.网上翻了一下找到知乎上一篇回答,试了一下好像不行,而且 ...