Android开发规范

一、命名规范

1、包命名

包一律小写，少用缩写和长命

采用规则：[基本包].[项目名].[模块名]

例如：com.routemap.util

2、类和接口命名

类名是个一名词，采用大小写混合的方式，每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词，避免用缩写词(除非该缩写词被更广泛使用，像URL，HTML)。

1)、抽象类使用A开头

2)、接口使用I开头

3)、实现类使用Imple结尾

4)、页面类：“Page”，例如“LoginPage”

5)、处理类：“Handle”，例如“LogicHandle”

6)、动作事件定义类：“Action”，例如“LoginAction”

7)、网络事件定义类：“Api”，例如“LoginApi”

8)、数据定义类：“Entity”，例如“FriendEntity”

9)、消息处理类：“Msg”，例如“LoginRequestMsg”

10)、资源管理类：“Manager”，例如“ImageManager”

11)、缓存类：“Cache”，例如“UserCache”

12)、参数传递类：“Param”，例如“LoginParam”

13)、功能提供类：“XUtil”，例如“XUtilMath”

备注：禁止使用中文字符，不能在命名字符串中出现“0-9”的数值描述，命名的字母组合尽量能够在本身的文字意义上初步了解类的大体功能。

3、全局变量命名

1、使用驼峰命名法，首字母用小写m开头以便和局部变量区分(使用完整单词)

例如：mUserName

2、组件或部件变量使用其类型名或类型名缩写作其后缀

例如：ImageView mPetHeaderIV

TextView mPhoneNumTV

3、集合类型变量，例如数组和矢量，应采用复数命名或使用表示该集合的名词做后缀。

String[] mNames;

List mPetList;

4、常量命名

全部使用大写static final int MIN_WIDTH = 4;

4、方法命名

1、方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写；取值类可使用get前缀，设值类可使用set前缀，判断类可使用is(has)前缀，方法里面不许出现0-9这样的数字。

2、方法名字需要见名知意。

例如：initView();

3、对于方法中一定要加上适当的非空判断，与try catch语句等等程序健壮性的判断。

5、layout布局文件命名

全部小写，采用下划线命名法

1、contentview命名, Activity默认布局，以去掉后缀的Activity类进行命名。不加后缀：

功能模块.xml

activity_功能模块.xml

例如：activity_main.xml、activity_more.xml

2、Dialog命名：dialog_描述.xml

例如：dlg_hint.xml

3、PopupWindow命名：ppw_描述.xml

例如：ppw _info.xml

4.、列表项命名listitem_描述.xml

例如：listitem_city.xml

5、包含项：include_模块.xml

例如：include_head.xml、include_bottom.xml

6、adapter的子布局：功能模块_item.xml

例如：main_item.xml

7、String.xml中的命名

命名模式：

activity名称_功能模块名称_逻辑名称/activity名称_逻辑名称/common_逻辑名称

strings.xml中，使用activity名称注释，将文件内容区分开来

二、注释

1、类和接口注释

在类名和接口名的顶部加入

/**

*

*@ClassName:类名

*@Description:TODO(这里用一句话描述这个类的作用)

*@author加上开发者名字开发者的邮箱地址

*@date2015-3-18 下午2:33:24开发时间

**/

2、方法注释

/**

*@Title:方法名

*@Description:TODO(这里用一句话描述这个方法的作用)

*@param设定文件

*@returnvoid    返回类型

*@throws

*/

3、属性注释

在有的属性单词比较不容易让人理解的时候记得加上注释

单行代码注释一律使用注释界定符"//"