Android开发编码规范.docx

Android开发编码规范.docx[Android编码规范文档]
[设计说明]
Android 编码规范 1
1. 前言 1
2. 编写目的 1
3. 使用范围 1
4. 编码规范 1
. 文件名 1
. 文件编码:UTF-8 1
. 源文件结构 1
. package语句 1
. import语句 2
. import不要使用通配符 2
. 不要换行 2
. 顺序和间距 2
. 类声明 2
. 只有一个顶级 2
. 类成员顺序 2
. 大括号 3
. 使用大括号(即使是可选的) 3
. 非空块:K & R 风格 3
. 空块:可以用简洁版本 4
. 具体结构 4
. 枚举类 4
. 变量声明 4
. 每次只声明一个变量 4
. 需要时才声明,并尽快进行初始化 4
. 数组 5
. switch语句 5
5. 命名规范 6
. 包名 6
. 类名 7
. 方法名 8
. 常量名 8
. 非常量字段名 9
. 参数名 10
. 局部变量名 10
. 类型变量名 11
. 资源文件命名规范 11
. 资源布局文件(XML文件(layout布局文件)) 11
. 资源文件(图片drawable文件夹下) 11
. 动画文件(anim文件夹下): 12
. values中name命名 13
. layout中的id命名 14
6. 编程实践 14
. ***@Override:能用则用 14
. 捕获的异常:不能忽视 14
. 静态成员:使用类进行调用 15
7. 注释 15
. 文件注释 15
. 类注释 15
. 方法注释 16
. 类成员变量和常量注释 16
. 其他注释 16
. XML注释 16
8. 附录: 16
Android 编码规范
前言
编码规范对于程序员尤为重要,可以有效的帮助我们进行code review,提高代码的可读性,让其他人更快的理解代码。一个软件的生命周期中,80%的花费都在于维护以及新功能的迭代,很多的时候都需要阅读代码,读自己以前写的代码,读别人写的代码,这样规范代码的优势就显示出来了,符合规范的代码可以让人简单快速的理解理解代码的意图。
编写目的
本规范由编程原则组成,融合并提炼了Android开发人员长时间积累下来的成熟经验,意在帮助形成良好一致的编程风格,以达到事半功倍的效果。
使用范围
适用于Android开发的应用。
编码规范
文件名
源文件以其最顶层的类名来命名,大小写敏感,。
文件编码:UTF-8
源文件编码格式为 UTF-8。
源文件结构
一个源文件包含(按顺序地):
package语句
import语句
一个顶级类(只有一个)以上每个部分之间用一个空行隔开。
package语句
package 语句不换行(即package语句写在一行里)。
import语句
import不要使用通配符
即,不要出现类似这样的import语句:import .*;
不要换行
import语句不换行(每个import语句独立成行)。
顺序和间距
import语句可分为以下几组,按照这个顺序,每组由一个空行分隔:
所有的静态导入独立成组
imports(.google包下)
第三方的包。每个顶级包为一组,字典序。例如:android, com, junit, org, sun
java imports组内不空行,按字典序排列。
类声明
只有一个顶级
类声明每个顶级类都在一个与它同名的源文件中(当然,)。
例外:package-,该文件中可没有package-info类。
类成员顺序
类的成员顺序对易学性有很大的影响,但这也不存在唯一的通用法则。不同的类对成员的排序可能是不同的。最重要的一点,每个类应该以某种逻辑去排序它的成员,维护者应该要能解释这种排序逻辑。比如, 新的方法不能总是习惯性地添加到类的结尾,因为这样就是按时间顺序而非某种逻辑来排序的。
区块划分
建议使用注释将源文件分为明显的区块,区块划分如下
常量声明区
UI控件成员变量声明区
普通成员变量声明区
内部接口声明区