Android 开发规范

摘要：良好的开发规范，可以提升代码的可读性，与代码质量。良好的开发规范也可以有效提升团队的开发效率，便于团队间的沟通。在进入程序员这个行业前，也看过很多人的代码，最讨厌的就是那些没有注释的代码，要花特别多的时间进行理解。所以遵循一个良好的开发规范，是提升程序员素养的一个重要方式。

主要针对Android开发规范进行介绍，其他也是异曲同工，有遗漏的地方请指出，相互学习。

本文参考：http://keeganlee.me/post/android/20150709

代码书写规范

统一编码，使用UTF-8进行编码，避免中文字符的乱码现象。

统一缩进，java语言编程时，换行基本是使用TAB进行缩进的，统一4个字符缩进，提高代码整洁度。

统一花括号，使用ctrl+shift+f（Windows）/Option+command+F（mac）快捷键进行代码格式化，即用默认的代码格式，如果需要团队开发的代码格式化模板，通过IDE进行导入。

空格的使用：逻辑关键字与后面的语句留一个空格隔开。

空行的使用：两个方法之间，方法内的两个逻辑段之间，方法内的局部变量和方法的第一条逻辑语句之间，常量和变量之间。

行宽设置，换行使用8字符缩进。

单变量声明，方便注释。

方法行数限定，能少尽量少。

文字统一使用SP单位，统一使用DP单位。

资源统一在资源文件中定义，在布局或代码中引用。

命名规范

包名：域名反转

类命名：使用驼峰命名法，用名词或名词词组命名，每个单词的首字母大写。

activity类，命名以Activity为后缀，如：LoginActivity

fragment类，命名以Fragment为后缀，如：ShareDialogFragment

service类，命名以Service为后缀，如：DownloadService

adapter类，命名以Adapter为后缀，如：CouponListAdapter

工具类，命名以Util为后缀，如：EncryptUtil

模型类，命名以BO为后缀，如：CouponBO

接口实现类，命名以Impl为后缀，如：ApiImpl

方法命名：使用驼峰命名规则，用动词命名，第一个单词的首字母小写，其他单词的首字母大写。

初始化方法，命名以init开头，例：initView

按钮点击方法，命名以to开头，例：toLogin

设置方法，命名以set开头，例：setData

具有返回值的获取方法，命名以get开头，例：getData

通过异步加载数据的方法，命名以load开头，例：loadData

布尔型的判断方法，命名以is或has，或具有逻辑意义的单词如equals，例：isEmpty

控件缩写

控件	缩写	控件	缩写
TextView	txt	EditText	edt
Button	btn	ImageButton	ibtn
RadioGroup	group	RadioButton	rbtn
ProgressBar	progress	SeekBar	seek
TableLayout	table	TableRow	row
ScrollView	scroll	SearchView	search
TabHost	host	TabWidget	widget

5. 常量命名：全部为大写单词，单词之间用下划线分开。

6. 变量命名：{范围描述+}意义描述+类型描述的组合，用驼峰命名规则，首字母小写。

7. 控件id命名：控件缩写_{范围_}意义，范围可选，只在有明确定义的范围内才需要加上。

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，中间缩小

注释规范

文件注释：包括文件作者，日期，文件功能描述

类和接口注释：类和接口统一添加javadoc注释，简单面试功能及作者

方法注释：说明该方法的用途和参数说明，以及返回值的说明。

接口中定义的所有方法

抽象类中自定义的抽象方法

抽象父类的自定义公用方法

工具类的公用方法

变量和常量注释：优先采用右侧//来注释，若注释说明太长则在上方添加注释。

接口中定义的所有常量

公有类的公有常量

枚举类定义的所有枚举常量

实体类的所有属性变量