Android 开发规范以及注意事项
Ajava 攻城师 Android 开发命名规范以及注意事项 zftlive@163.com
第 2 页 共 13 页
修订历史记录
日期
版本
说明
作者
2014-10-20
1.0
初始建立
曾繁添
2015-05-19
V1.1
基本完善各个章节内容
曾繁添
2015-08-12
V1.2
更新代码混淆注意事项、color 命名
曾繁添
Ajava 攻城师 Android 开发命名规范以及注意事项 zftlive@163.com
第 3 页 共 13 页
目录
1. 简介 3
1.1 目的 3
1.2 范围 3
2. 命名原则 3
3. 开发规范 3
3.1 工程名 4
3.2 包名 4
3.3 类文件 4
3.4 类属性 4
3.5 成员变量 4
3.6 方法名 5
3.7 布局文件- layout 5
3.8 资源文件- drawable 5
3.9 动画文件- anmi 6
3.10 配置文件- values 6
3.11 代码混淆 7
3.12 AndroidManifest.xml 9
4. 内存泄露 10
5. 注意事项 11
6. 常见错误 12
7. 参考资料 12
8. 备注 12
1. 简介
本文档用于指导开发人员在安卓项目开发过程中类名、资源文件名、变量名等开发约定以及命名规
范，方便工程的后期维护，提高代码整体质量、可读性。
1.1 目的
统一开发人员代码编写命名规范，提高代码可读性、以及专业程度，方便后期维护管理
1.2 范围
适用于安卓项目开发领域范畴
2. 命名原则
命名尽量简洁、见名思意，禁止出现 a b c 此类低俗、无意义的弱智命名。代码编写规则风格要保持
一致
3. 开发规范
Ajava 攻城师 Android 开发命名规范以及注意事项 zftlive@163.com
第 4 页 共 13 页
3.1 工程名
工程的命名需要精简、有代表性、符合 Java 命名规范，让别人一看到名称就大概知道该工程是做什么
的。不能以特殊符号、下划线、空格、数字、中文开头。名称要见名思意、组成单词首字母大写、或者全
部小写。例如：ApiDemos、zftlive
3.2 包名
包命名一概不允许出现大写字母，虽然大写字母不违反 java 标准命名规范，但是任何一个开源框架基
本没有出现大写、下划线、特殊符号的包名，必须全部小写、将具有共性、特殊职责处理的类归纳到一个
包下，包名称使用具有代表意义的小写英文单词组成或者单词的简称组成。例如：com.zftlive.base
com.zftlive.tools com.zftlive.common
例如：
3.3 类文件
类名称必须首字母大写、杜绝出现汉字，完全参照 Java 命名规范
UI 界面对应的类必须加入相应类型的后缀：XxxxActivity、XxxxFragment，XxxxDialog 方便阅读者快
速了解实现的 UI 布局
3.4 类属性
类的属性命名参照 Java 命名规范，以小写字母开头，每个连接单词首字母大写、禁止出现随意命名 aa
bb _ab123 此类的属性名称。
Boolean 类型的属性推荐 is 或者 has 作为前缀。
3.5 成员变量
类的属性命名参照谷歌推荐写法，以 m 开头+对应的机能名称+实力对象名称（例如：
mTopicListview、mListAdapter）；
控件属性命名以控件前缀+功能名称组成（例如：tv_project_name、rl_root_view）
