Android编码规范

window->Preferences->general->Content Types，右侧Context Types树，点开Text，选择Java Source File，在下面的Default encoding输入框中输入UTF-8，点Update，则设置Java文件编码为UTF-8。其他java应用开发相关的文件如： properties、XML等已经由Eclipse缺省指定，分别为ISO8859-1，UTF-8，如开发中确需改变编码格式则可以在此指定。

模板和格式模板文件

导入方法下：

Window->preferences->Java->Code Style->Organize Imports 导入android.imported

Window->preferences->Java->Code Style->Formatter导入android-formatting.xml

Tab与空格

程序中不允许出现Tab符号，所有的Tab需用4个空格来代替，请用如下方法配置：

Window->Preferences->General->Editors->Text Editors->Insert spaces for tabs

XML文件的Tab格式也需要单独配置一下，用如下方法配置:

Window->Preferences->XML->XML Files->Editor

2.3 Eclipse配置方法

注释模板

在eclipse 的preferences 中，选择 java à code style àcode Template

1. 添加文件创建日志模板

2.设置类注释模板

导入方法

在eclipse 的preferences 中，选择 java à code style àcode Template 中选择 Import，选择附件中的文件。

但是注意修改类注释和文件注释的作者名称为自己的！

格式化模板

在eclipse 的preferences 中，选择 java à code style àformatter 中选择 Import，选择附件中的文件。

XML格式化

在eclipse 的preferences 中，选择 xml à xml files à xml editor 中做如下设置

。

3命名注释规范

命名规范使程序更易读，从而更易于理解。它们也可以提供一些有关标识符功能的信息，以助于理解代码，不论它是一个常量、包、还是类。

需要注意的是：

1.使用完整的英文描述来命名

2.避免命名超长（15 个字符以内比较好）

3.避免相似的命名。例如：persistentObj 和persistentObjs 不要一起使用；anSqlStmt 和anSQLStmt 不要一起使用

4.慎用缩写，如果要用到缩写，请参考下一条

5.按照缩写规则使用缩写。例如：No.代表number 数字，ID.代表identification标示。

3.1命名规范汇总

标识符类型

命名规则

例子

包(Packages)

一个唯一包名的前缀总是全部小写的ASCII 字母。所有项目包名以com.chinacache 开头。后面是程序所在项目的英文名称，不含版本号（除非有特别需要与以前版本区分，如：两个版本可能同时运行），再下为子系统的名称，每个子系统内按照类别区分。

com.chinacache.billing

com.chinacache.billing.node

com.chinacache.billing.node.util

类(Classes)

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

class Raster;

class ImageSprite;

接口(Interfaces)

命名规则：大小写规则与类名相似，常以

"able"、"ible"结尾。

interface RasterDelegate;

interface Runnable;

interface Accessible;

方法(Methods)

方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。

run();

runFast();

getBackground();

变量(Variables) 参数(Parameter)

变量用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。变量名不应以下划线或美元符号开头，尽管这在语法上是允许的。

变量名应简短且富于描述。变量名的选用应该易于记忆，即，能够指出其用途。尽量避免单个字符的变量名，除非是一次性的临时变量。临时变量通常被取名为i，j，k，m 和n，它们一般用于整型；c，d，e，它们一般用于字符型。

char c;

int i;

float myWidth;

集合(Collection)

数组(Array)

集合变量例如数组、向量，在命名的时候

必须从名字上面体现出该变量为复数、数

组。还可以巧妙的使用some 词头。

customers，orderItems，

postedMessages

someCustomers，someItems，

someMessages

常量(Constants)

常量的声明，应该全部大写，单词间用下

划线隔开。

static final int MIN_WIDTH = 4;

static final int MAX_WIDTH = 999;

static final int GET_THE_CPU = 1;

1包命名

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

例如： com.hymobile.nloc.activities

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

如：com.hymobile.项目缩写.模块名 à com.hymobile.nloc.bookmark

如：com.hymobile.项目缩写.层级名 à com.hymobile.nloc.activities

2类和接口命名

接口一般要使用able、ible、er 等后缀

例如： class Raster; class ImageSprite;

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

如：class BookMarkAdd à 正确

如：class AddBookReadPlanActivity à 错误！ 应为 class BookReadPlanAdd

3方法的命名

命名规则：方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。

例如： 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(),其格式为：

4变量命名

命名规则：第一个单词的首字母小写，其后单词的首字母大写。变量名不应以下划线或美元符号开头，尽管这在语法上是允许的。变量名应简短且富于描述。变量名的选用应该易于记忆，即，能够指出其用途。尽量避免单个字符的变量名，除非是一次性的临时变量。临时变量通常被取名为 i，j，k，m 和 n，它们一般用于整型；c，d，e，它们一般用于字符型。（全局变量在前加上小写m）

例如：String bookName;

String mBookName；

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

如：String bookName; à 正确

如：String bookNameString; à错误！

3.2注释规范

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

1文件注释

如下：

* 文件名

* 包含类名列表

* 版本信息，版本号

* 创建日期。

2类注释

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

/**

* 类名

* @author 作者 <br/>

* 实现的主要功能。

* 创建日期

* 修改者，修改日期，修改内容。

3方法注释

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

/**

* 方法的一句话概述

* <p>方法详述（简单方法可不必详述）</p>

* @param s 说明参数含义

* @return 说明返回值含义

* @throws IOException 说明发生此异常的条件

* @throws NullPointerException 说明发生此异常的条件

方法注释的内容（1，5，6，7项正常情况下都要写上去）

1.类该方法是做什么的。

2.该方法如何工作。

3.代码修改历史纪录。

4.方法调用代码示范。

5.必须传入什么样的参数给这个方法。@param

6.异常处理。@throws

7.这个方法返回什么。@return

4类成员变量和常量注释

成员变量和常量需要使用java doc形式的注释，以说明当前变量或常量的含义

/**

* XXXX含义

5其他注释

方法内部的注释如果需要多行使用/*…… */形式，如果为单行是用//……形式的注释。不要再方法内部使用 java doc 形式的注释"/**……**/"，简单的区分方法是，java doc形式的注释在 eclipse中为蓝色，普通注释为绿色。

XML注

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

生成API的方法

选择工程，鼠标右键菜单Export ，选择Java 下面的Javadoc ，点"next" 按钮

Javadoc command 里选javadoc.exe 的目录，如：C:\Program Files\Java\jdk1.6.0_10\bin\javadoc.exe

选择生成到Javadoc 文档中的内容( 一般选public 或protected) ，选存放目录( 默认即可) ，next下一步 ,此页全默认即可，再next 下一步。

如果项目采用的是 UTF － 8 的编码，一定要在这一页的Extra Javadoc options 中加" -encoding UTF-8 -charset UTF-8 〃。否则生成的网页中文注释都是乱码。点 Finish 完成

所有的代码注释都会被自动加入api中，所以为了让他人看懂所写代码，在编写程序代码的时候尽量加全所有可以被加入到api中的注释。

3.3代码风格

1缩进

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

2空行

空行将逻辑相关的代码段分隔开，以提高可读性。

下列情况应该总是使用空行：

一个源文件的两个片段(section)之间
类声明和接口声明之间
两个方法之间
方法内的局部变量和方法的第一条语句之间
一个方法内的两个逻辑段之间，用以提高可读性

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

3行宽

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

3.4代码规约

1方法

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

不要使用 try catch 处理业务逻辑！！！！

2参数和返回值

一个方法的参数尽可能的不要超过4个！

如果一个方法返回的是一个错误码，请使用异常！！

尽可能不要使用null，替代为异常或者使用空变量如返回 List 则可以使用Collections.emptyList()

3神秘的数

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

4控制语句

判断中如有常量，则应将常量置于判断式的右侧。如：

if ( true == isAdmin())...

尽量不使用三目条件的嵌套。

所有if 语句必须用{}包括起来,即便是只有一句：

if (true){

//do something......

}

if (true)

i = 0; //不要使用这种

对于循环：

//不推荐方式____________________________________________

while(index < products.getCount()){

//每此都会执行一次getCount()方法，

//若此方法耗时则会影响执行效率

//而且可能带来同步问题，若有同步需求，请使用同步块或同步方法

}

//推荐方式______________________________________________

//将操作结构保存在临时变量里，减少方法调用次数

final int count = products.getCount();

while(index < count){

}

5异常的捕捉处理

通常的思想是只对错误采用异常处理：逻辑和编程错误，设置错误，被破坏的数据，资源耗尽，等等。

通常的法则是系统在正常状态下以及无重载和硬件失效状态下，不应产生任何异常。

最小化从一个给定的抽象类中导出的异常的个数。对于经常发生的可预计事件不要采用异常。不要使用异常实现控制结构。

若有finally 子句，则不要在try 块中直接返回，亦不要在finally 中直接返回。

6访问控制

若没有足够理由，不要把实例或类变量声明为公有。通常，实例变量无需显式的设置(set)和获取(gotten)，通常这作为方法调用的边缘效应 (side effect)而产生。

一个具有公有实例变量的恰当例子，是类仅作为数据结构，没有行为。亦即，若你要使用一个结构(struct)而非一个类(如果java 支持结构的话)，那么把类的实例变量声明为公有是合适的。

3.5约定俗称

1变量赋值

避免在一个语句中给多个变量赋相同的值。它很难读懂。例如：

fooBar.fChar = barFoo.lchar = 'c';

不要将赋值运算符用在容易与相等关系运算符混淆的地方。例如：

if (c++ = d++) { // AVOID! (Java disallows)

...

}

应该写成

if ((c++ = d++) != 0) {

...

}

不要使用内嵌(embedded)赋值运算符试图提高运行时的效率，这是编译器的工作。例如：

d = (a = b + c) + r; // AVOID!

应该写成

a = b + c;

d = a + r;

2圆括号

一般而言，在含有多种运算符的表达式中使用圆括号来避免运算符优先级问题，是个好方法。

即使运算符的优先级对你而言可能很清楚，但对其他人未必如此。你不能假设别的程序员和你一样清楚运算符的优先级。

if (a == b && c == d) // AVOID!

if ((a == b) && (c == d)) // RIGHT

3返回值

设法让你的程序结构符合目的。例如：

if (booleanExpression) {

return true;

} else {

return false;

}

应该代之以如下方法：

return booleanExpression

类似地：

if (condition) {

return x;

}

return y;

应该写做：

return (condition ? x : y);

4条件运算符"?"前的表达式

如果一个包含二元运算符的表达式出现在三元运算符" ? : "的"?"之前，那么应该给表达式添上一对圆括号。例如：

(x >= 0) ? x : -x

3.6其他专门要求

编码
除了String.xml文件中可以出现非英文字符外，其他所有的Java文件，xml文件中只允许出现英文字符。
所有Java文件，UI配置xml文件中不允许出现硬编码。字符串的国际化请写入String.xml文件，配置信息请写入config.xml文件，分辨率相关信息请写入dimens.xml文件
变量：
变量的命名应具有"自明性"，例如声明一个表示电话号码的局部变量，可以这么写："String mobileNumber"。除了for循环中可以使用int i，j这样的命名方式，其他地方禁止使用这种没有"自明性"的命名
所有静态变量都必须以s开头，例如："sMobileNumber"
所有的非静态变量必须以m开头，例如："mMobileNumber"
所有常量必须采用全大写方式，单词之间用下划线分割，例如："MOBILE_NUMBER"。此时f.不要再加如"s"或"m"前缀
局部变量的作用域一定要最小化
所有成员变量必须都定义在类的开始，定义顺序如下：常量->public 变量->private 变量
所有xml配置文件中的变量命名，采用全小写命名，单词间用下划线分割。
异常处理
尽量不要使用try catch捕获异常，而是显式的抛出一个异常。
使用try catch 一定要在catch语句中做好相应的处理，不能留空。在catch中可以赋默认值，做错误处理或抛出一个自己封装的异常类对象（但不能抛出RuntimeException异常）
不要捕获Exception类型的异常
使用Finally这个关键字时，需要注意其中的代码执行时间点是无法确定的（无法确定是return之前还是之后）。