android开发规范

Android开发规范
一切规范都必须以执行为第一准则
一、命名规范
1、包命名：域名反写+功能名称+模块名称
2、类和接口命名：使用大驼峰规则，用名词或者名词词组命名，每个单词的首字母大
写。

以下是几种常用类的命名：
i.Activity类，命名以Activity为后缀，如：LoginActivity
ii.Fragment类，命名以Fragment为后缀，如UserFragment
iii.Service类，命名以Service为后缀，如DownloadServer
iv.Adapter类，命名以Adapter为后缀，如PersionAdapter
v.工具类，命名以Util（utility的缩写）为后缀，如DateUtil
vi.模型类，命名以BO（bean object的缩写）为后缀，如UserBO
vii.接口实现类，命名以Impl（implement的缩写）为后缀，如ApiImpl
3、方法命名：使用小驼峰命名规则，用动词命名，第一个单词的首字母小写，其它单
词首字母大写。

以下是几种常用的命名规则：
i.初始化方法，命名以init开头，例：initView
ii.按钮点击方法，命名以to开头，例：toLogin
iii.设置方法，命名为set开头，例：setData
iv.具有返回值的获取方法，命名以get开头，例：getData
v.通过异步加载数据的方法，命名以load开头，例：loadData
vi.布尔型的判断方法，命名以is或has，例：isEmpty
4、控件和数据类型缩写：
5、常量命名：全部为大写单词，单词之间用下划线分开。

6、变量命名：意义描述+类型描述的组合，用小驼峰式，首字母小写其余单词字母大写。

7、控件id命名：意义_控件缩写
8、Layout 命名：组件类型_功能以下为几种常用的组件类型命名：
i.act_功能，为activity的命名格式
ii.fra_功能，为fragment的命名格式
iii.dia_功能，为dialog的命名格式
iv.item_list_功能，为listview的item命名格式
v.item_grid_功能，为GridView的item命名格式
vi.header_list_{范围_}功能，为ListView的HeaderView命名格式vii.footer_list_{范围_}功能，为ListView的FooterView命名格式
9、String的命名：类型_功能，以下为几种常用的命名：
i.页面标题，命名格式为：title_页面
ii.按钮文字，命名格式为：btn_按钮事件
iii.标签文字，命名格式为：label_标签文字
iv.选项卡文字，命名格式为：tab_选项卡文字
v.消息框文字，命名格式为：toast_消息
vi.编辑框的提示文字，命名格式为：hint_提示信息
vii.图片的描述文字，命名格式为：desc_图片文字
viii.对话框的文字，命名格式为：dialog_文字
ix.menu的item文字，命名格式为：action_文字
10、Colors的命名
i.背景颜色，添加bg前缀
ii.文本颜色，添加text前缀
iii.分割线颜色，添加div前缀
iv.区分状态时，默认状态的颜色，添加normal后缀
v.区分状态时，按下时的颜色，添加pressed后缀
vi.区分状态时，选中时的颜色，添加selected后缀
vii.区分状态时，不可用时的颜色，添加disable后缀
11、Drawable的命名：
i.图标类，添加ic前缀
ii.背景类，添加bg前缀
iii.分割类，添加div前缀
iv.默认类，添加def前缀
v.区分状态时，默认状态的颜色，添加normal后缀
vi.区分状态时，按下时的颜色，添加pressed后缀
vii.区分状态时，选中时的颜色，添加selected后缀
viii.区分状态时，不可用时的颜色，添加disable后缀
ix.多种状态的，添加selector后缀（一般为ListView的selector或按钮的selector）
12、动画文件命名：动画类型_动画方向：
i.fade_in，淡入
ii.fade_out，淡出
iii.push_down_in，从下方推入
iv.push_down_out，从下方推出
v.slide_in_from_top，从头部滑动进入
vi.zoom_enter，变形进入
vii.shrink_to_middle，中间缩小
二、注释规范
1、文件头注释：文件顶部统一增加文件说明，声明格式如下（可以设置自动生成）：
2、类和接口注释：类和接口统一添加javadoc注释，格式如下：
3、方法注释：所有方法必须添加注释，说明该方发用途和参数说明，以及返回值的说明：
i.接口中定义的所有方法
ii.抽象类中自定义的抽象方法
iii.抽象父类的自定义公用方法
iv.工具类的公用方法
4、变量和常量注释：下面几种情况下的常量和变量，都要添加注释说明，优先采用右侧//来注释，若注释说明太长则在上方添加注释。

i.接口中定义的所有常量
ii.公有类的公有常量
iii.枚举类定义的所有枚举常量
iv.实体类的所有属性变量
三、书写规范
1、编码规范：统一使用UTF-8
2、缩进统一为4个空格，将Tab size设置为4则可以保证tab按键4个空格缩进。

3、花括号不要单独换行，和它前面的代码同一行。

而且，花括号与前面代码之间用一个空格隔开。

4、空格的使用
a)if、else、switch、while等逻辑关键词与后面的语句留一个空格隔开
b)运算符两边各用一个
c)方法的每个参数之间用一个空格隔开
5、空行的使用：将逻辑先关的代码用空行隔开，以提高程序的可读性。

空行也只空一
行，不要空多行。

在一下情况需要一个空行
b)两个方法之间
c)方法内的两个逻辑之间
d)方法内的局部变量和方法的第一条逻辑语句之间
e)常量和变量之间
6、当一个表达式无法容纳在一行内时，可以换行显示，另起的新行用8个空格缩进。

7、一个声明一个变量，不要一行声明多个变量，这样有利于写注释。

8、一个方法最多不超过40行代码
9、文字大小统一用sp表示，元素大小单位统一用dp表示。

10、应用中的字符串（java代码中和xml代码中）统一在string中定义，然后在代码和布局文件中引用。

11、颜色值统一在colors.xml中定义，然后在代码和布局文件中引用。

另外，不要在代码和布局文件中引用系统的颜色，除了透明。