Android编码规范V11.doc

一千零一夜产品部

一千零一夜途遇科技有限公司
2015-11-03
版本
修订内容
作者
时间

初稿
刘伟
2015-11-03

修正规则
刘伟
2016-05-24
介绍
为什么需要编码规范?
编码规范对于程序员而言尤为重要，有以下几个原因：
一个软件的生命周期中，80%的花费在于维护
几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护
编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码
如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品
命名
包命名
命名规则：一个唯一包名的前缀总是全部小写的ASCII 字母并且是一个顶级域名，通常是com，edu，gov，mil，net，org。包名的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门 (department) ，项目(project)，机器(machine)，或注册名(login names)。
例如：
规约：，后面跟有项目名称（或者缩写）,再后面为模块名或层级名称。
如： à
如： à
类和接口命名
命名规则：类名是个一名词，采用大小写混合的方式，每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词，避免缩写词(除非该缩写词被更广泛使用，像 URL，HTML)
接口一般要使用able、ible、er 等后缀
例如： class Raster; class ImageSprite; ImagePagerChangeListener
类命名规范：
ActivityàLoginActivity
FragmentàHomeFm
ModelàBaseModel
ParseràBaseParser
UtilàDataUtil
ViewàHWebView
…
其余略
方法的命名
命名规则：方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。
例如： public void run(); public String getBookName();
类中常用方法的命名：
类的获取方法（一般具有返回值）一般要求在被访问的字段名前加上get，如
getFirstName()，getLastName()。一般来说，get前缀方法返回的是单个值，find前缀的方法返回的是列表值。
类的设置方法（一般返回类型为void）：被访问字段名的前面加上前缀 set，如
setFirstName(),setLastName().
类的布尔型的判断方法一般要求方法名使用单词 is或has做前缀，如isPersistent()，isString()。或者使用具有逻辑意义的单词，例如equal 或equals。
类的普通方法一般采用完整的英文描述说明成员方法功能，第一个单词尽可能采用动词，首字母小写，如openFile（），addCount（）。
构造方法应该用递增的方式写。（参数多的写在后面）。
toString()方法：一般情况下，每个类都应该定义toString(),其格式为：
变量命名
命名规则：第一个单词的首字母小写，其后单词的首字母大写。变量名不应以下划线或美元符号开头，尽管这在语法上是允许的。变量名应简短且富于描述。变量名的选用应该易于记忆，即，能够指出其用途。尽量避免单个字符的变量名，除非是一次性的临时变量。临时变量通常被取名为 i，j，k，m 和 n，它们一般用于整型；c，d，e，它们一般用于字符型。
例如：StringbookName;
规约：变量命名也必须使用驼峰规则，但是首字母必须小写，变量名尽可能的使用名词或名词词组。同样要求简单易懂，不允许出现无意义的单词。
如：String bookName; à 正确
如：String bookNameString; à错误！
成员变量命名
同变量命名，但不要在私有变量前添加m字样！
常量命名
命名规则：类常量的声明，应该全