Android 编程规范(转)

前言：做Android开发这么久了，却从没有完全按照规范写代码，今天总结下。

为什么需要编码规范?

编码规范对于程序员而言尤为重要，有以下几个原因：
 
一个软件的生命周期中，80%的花费在于维护
几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护
编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码
如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品

命名

包命名
命名规则：一个唯一包名的前缀总是全部小写的ASCII 字母并且是一个顶级域名，通常是com，edu，gov，mil，net，org。包名的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门 (department) ，项目(project)，机器(machine)，或注册名(login names)。
例如： com.moleader.nloc.activities

规约：包命名必须以com.moleader开始，后面跟有项目名称（或者缩写）,再后面为模块名或层级名称。
如：com.moleader.项目缩写.模块名  com.moleader.nloc.bookmark
如：com.moleader.项目缩写.层级名  com.moleader.nloc.activities

 

类和接口命名
命名规则：类名是个一名词，采用大小写混合的方式，每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词，避免缩写词(除非该缩写词被更广泛使用，像 URL，HTML)
接口一般要使用able、ible、er 等后缀
例如： class Raster;  class ImageSprite;

规约：类名必须使用驼峰规则，即首字母必须大写，如果为词组，则每个单词的首字母也必须要大写，类名必须使用名词，或名词词组。要求类名简单，不允许出现无意义的单词（如 class XXXActivity）。
如：class BookMarkAdd  正确
如：class AddBookReadPlanActivity  错误！ 应为 class BookReadPlanAddActivity

方法的命名
命名规则：方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。
例如： 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，它们一般用于字符型。
例如：String bookName;

规约：变量命名也必须使用驼峰规则，但是首字母必须小写，变量名尽可能的使用名词或名词词组。同样要求简单易懂，不允许出现无意义的单词。
如：String bookName;  正确
如：String bookNameString; 错误！

成员变量命名
同变量命名，但不要在私有变量前添加m字样！

常量命名
命名规则：类常量的声明，应该全部大写，单词间用下划线隔开。
例如：static final int MIN_WIDTH = 4;
例如：static final int MAX_WIDTH = 999;
例如：static final int GET_THE_CPU = 1;

异常命名
自定义异常的命名必须以Exception为结尾。已明确标示为一个异常。

layout 命名
规约：layout xml 的命名必须以全部单词小写，单词间以下划线分割，并且使用名词或名词词组，即使用 view缩写_模块名称_view的逻辑名称来命名。Activity中View的命名格式：逻辑名称+view缩写

如：knowledge_gained_main.xml正确
如：list_book.xml错误！

id 命名
规约：layout 中所使用的id必须以全部单词小写，单词间以下划线分割，并且使用名词或名词词组，并且要求能够通过id直接理解当前组件要实现的功能。
如：某TextView @+id/textbookname 错误 !应为 @+id/book_name_show
如：某EditText @+id/textbookname 错误 !应为 @+id/book_name_edit

 

资源命名
规约：layout中所使用的所有资源（如drawable,style等）命名必须以全部单词小写，单词间以下划线分割，并且尽可能的使用名词或名词组，即使用 activity名_模块名_用途 来命名。如果为公共资源，如分割线等，则直接用用途来命名
如：menu_icon_navigate.png  正确
如：某分割线：line.png  或 separator.png 正确

 

注释
Java 程序有两类注释：实现注释(implementation comments)和文档注释(document comments)。实现注释是使用和//界定的注释。文档注释(被称为"doc comments")由界定。文档注释可以通过javadoc 工具转换成HTML 文件。

 

文件注释
所有的源文件都应该在开头有一个注释，其中列出类名、版本信息、日期和版权声明。
如下：
   ‘/’*
    * 文件名
    * 包含类名列表
    * 版本信息，版本号
    * 创建日期。
    * 版权声明
    *‘/’

类注释
每一个类都要包含如下格式的注释，以说明当前类的功能等。

 ‘/’**
  * 类名
  * @author 作者 <br/>
  * 实现的主要功能。
  * 创建日期
 * 修改者，修改日期，修改内容。
*‘/’

 

方法注释
每一个方法都要包含如下格式的注释包括当前方法的用途，当前方法参数的含义，当前方法返回值的内容和抛出异常的列表。

 ‘/’**
  *
  * 方法的一句话概述
  * <p>方法详述（简单方法可不必详述）</p>
  * @params 说明参数含义
  * @return 说明返回值含义
  * @throws IOException 说明发生此异常的条件
  * @throws NullPointerException 说明发生此异常的条件
  *‘/’

 

类成员变量和常量注释
成员变量和常量需要使用java doc形式的注释，以说明当前变量或常量的含义
‘/’**
 * XXXX含义
  *‘/’
 
其他注释
方法内部的注释如果需要多行使用‘/’*…… *‘/’形式，如果为单行是用//……形式的注释。不要再方法内部使用 java doc 形式的注释‘/’**……**‘/’，简单的区分方法是，java doc形式的注释在 eclipse中为蓝色，普通注释为绿色。

XML注释
规约：如果当前layout 或资源需要被多处调用，或为公共使用的layout（若list_item），则需要在xml写明注释。要求注释清晰易懂。

 

代码风格：

缩进
规约：不允许使用Tab进行缩进，使用空格进行缩进，推荐缩进为2空格。

空行
 空行将逻辑相关的代码段分隔开，以提高可读性。
下列情况应该总是使用空行：
一个源文件的两个片段(section)之间
类声明和接口声明之间
两个方法之间
方法内的局部变量和方法的第一条语句之间
一个方法内的两个逻辑段之间，用以提高可读性

规约：通常在变量声明区域之后要用空行分隔，常量声明区域之后要有空行分隔，方法声明之前要有空行分隔。

行宽
无特别规定，因为现在的显示器都比较大，所以推荐使用120进行设置。

规约

方法
一个方法尽量不要超过15行，如果方法太长，说明当前方法业务逻辑已经非常复杂，那么就需要进行方法拆分，保证每个方法只作一件事。
不要使用 try catch 处理业务逻辑！！！！

参数和返回值
一个方法的参数尽可能的不要超过4个！
如果一个方法返回的是一个错误码，请使用异常！！
尽可能不要使用null， 替代为异常 或者使用空变量 如返回 List 则可以使用Collections.emptyList()

神秘的数
代码中不允许出现单独的数字，字符！如果需要使用数字或字符，则将它们按照含义封装为静态常量！（for语句中除外）

 

部分经验总结：

1、 onCreate中完成控件的初始化onResume中完成数据的准备。

2、重复逻辑需要抽象成方法放在类的代码中调用多个类都需要使用到的方法可以做成工具类放在*.utils里大量代码的方法重写放在*.adapter里。

3、应尽量避免使用类变量。一般来说，变量的作用域越小越好。为了减少类变量，方法之一是将数据作为参数在不同方法之间传递，而不是让方法共享类变量。

4、java代码中不要出现中文。

5、程序中应该有足够的调试信息，一般来讲调试信息必须指明此信息是在哪个文件、哪个方法、哪一行输出的。调试信息的文字描述不应采用缩写的方式，应当尽可能的描述清楚此调试信息的目的。

6、styles.xml：将layout中不断重现的style提炼出通用的style通用组件，放到styles.xml中.

7、如果多个Activity中包含共同的UI处理，那么可以提炼一个CommonActivity，把通用部分叫由它来处理，其他activity只要继承它即可。

8、当快速滑动列表时（SCROLL_STATE_FLING），item中的图片或获取需要消耗资源的view，可以不显示出来；而处于其他两种状态（SCROLL_STATE_IDLE和SCROLL_STATE_TOUCH_SCROLL），则将那些view显示出来。

9、数字、字母和汉字混排占位问题：将数字和字母全角化。由于现在大多数情况下我们的输入都是半角，所以字母和数字的占位无法确定，但是一旦全角化之后，数字、字母的占位就和一个汉字的占位相同了，这样就可以避免由于占位导致的排版问题。