参考地址
术语说明
在文档中，除非另有说明：
术语 class 可表示一个普通类，枚举类，接口或是annotation类型(@interface)
术语 comment 只用来指代实现的注释(implementation comments)，我们不使用”documentation comments”一词，而是用 Javadoc。其他的术语说明会偶尔在后面的文档出现。
源文件基础
文件名
源文件以其最顶层的类名来命名，大小写敏感，文件扩展名为.java
文件编码
所有格式统一为UTF-8
特殊字符
空白字符
除了行结束符序列，ASCII水平空格字符(0×20，即空格)是源文件中唯一允许出现的空白字符，这意味着：
所有其它字符串中的空白字符都要进行转义。
制表符不用于缩进（可以在IDE中Tab键设置为若干个空格）。
特殊转义序列
除了行结束序列，ASCII水平空格字符（0x20）是源文件中唯一允许出现的空白字符。就是说其他字符都要进行转义。
特殊转义序列
对于具有特殊转义序列的字符（\b,\f,\n等）不能使用相应8进制或Unicode转义。
非ASCII字符
对于剩余的非ASCII字符，是使用实际的Unicode字符还是使用等价的转义符（\u221e）取决于那个更利于阅读和理解。
源文件结构
一个源文件应包含（按顺序）：
许可证版权信息（如有需要）
prckage 语句
import 语句
顶级类（以上每个须用空行隔开）
import中不使用通配符
如：import java.util.*;
import语句不换行
类声明
只有一个顶级类
类声明每个顶级类都在一个与它同名的源文件中（当然，还包含.java后缀）。
类成员顺序
每个类应该以某种逻辑去排序它的成员，维护者应该要能解释这种排序逻辑。比如， 新的方法不能总是习惯性地添加到类的结尾，因为这样就是按时间顺序而非某种逻辑来排序的。
区块划分
建议用注释将源文件分为明显的区块，区块划分如下：
常量声明区
UI控件成员变量声明区
内部接力声明区
初始化相关方法区
事件响应方法区
普通逻辑方法区
重载逻辑方法区
发起异步任务方法区
异步任务回调方法区
生命周期回调方法区（不包含oncreate）
内部类声明区
类成员排列通用规则
按照发生的先后顺序排列
常量按照使用先后排列
UI控件成员变量按照layout文件中的先后顺序排列
普通成员变量按照使用的先后顺序排列
方法基本上都按照调用的先后顺序在各自区块中排列
相关功能作为小区块放在一起（或者封装掉）
重载：永不分离
当一个类有多个构造函数，或是多个同名方法，这些函数/方法应该顺序的出现在一起。
格式术语
说明：块状结构指一个类，方法或构造函数主题。
大括号
使用大括号（即使是可选的）
大括号与if, else, for, do, while语句一起使用，即使只有一条语句(或是空)，也应该把大括号写上。
空块:可以用简洁版本
一个空的块状结构里什么也不包含，大括号可以简洁的写成{}，不需要换行。例外：如果它是一个多块语句的一部分(if/else 或 try/catch/finally) ，即使大括号内没内容，右大括号也要换行。
块缩进：4个空格
当增加一个新的块时，缩进增加4个空格，当块结束时，缩进返回先前缩进级别。缩进级别适用于代码和注释。
一行一个语句
每个语句后要换行
具体结构
每次只声明一个变量
不要使用组合声明，比如int a, b（不强制）
在需要时才声明，并尽快进行初始化
不要在一个代码块的开头吧局部变量一次性都声明，而是在第一次使用时再声明。并且在声明后尽快进行初始化。
数组
数组初始化可以写成块状结构
比如，下面的写法都是OK的：
- new int[] {
0, 1, 2, 3
} - new int[] {
0,
1,
2,
3
} - new int[] {
0, 1,
2, 3
} - new int[]
{0, 1, 2, 3}
非C风格的数组声明
中括号是类型的一部分：String[] args， 而非 String args[]。
switch语句
术语说明：switch块的大括号内是一个或多个语句组。
每个语句组包含一个或多个switch标签(case FOO:或default:)，后面跟着一条或多条语句。
缩进
与其它块状结构一致，switch块中的内容缩进为2个空格。每个switch标签后新起一行，再缩进2个空格，写下一条或多条语句。
default的情况要写出来
每个switch语句都包含一个default语句组，即使它什么代码也不包含。
注解
注解紧跟在文档块后面，应用于类、方法和构造函数，一个注解独占一行。这些换行不属于自动换行，因此缩进级别不变。
注释
- 注释尽量使用javadoc注释
- 在方法内的注释可以使用//
- 注释不可使用行尾注释
Modifiers
类和成员的modifiers如果存在，则按Java语言规范中推荐的顺序出现。
public protected private
abstract
static
final
transient
Volatile
synchronized
native
strictfp
命名约定
对所有标识符懂通用的规则
标识符只能使用ASCII字母和数字，因此每个有效的标识符名称都能匹配正则表达式\w+
标识符类型的规则
包名
包名全部小写，连续的单词只是简单地连接起来，不使用下划线。
采用反域名命名规则，全部使用小写字母。一级包名为com，二级包名为drhb，三级包名根据应用进行命名，四级包名为模块名或层级名。
包名 此包中包含com.xx.应用名称缩写
- .activity 页面用到的Activity类 (activitie层级名用户界面层)
- .base 基础共享的类
- .adapter 页面用到的Adapter类 (适配器的类)
- .util 此包中包含：公共工具方法类（util模块名）
- .bean 下面可分：vo、po、dto 此包中包含：JavaBean类
- .model 此包中包含：模型类
- .db 数据库操作类
- .view (或者 com.xx.应用名称缩写.widget ) 自定义的View类等* .service Service服务
- .receiver BroadcastReceiver服务
- 所有M、V、P抽取出来的接口都放置在相应模块的i包下，所有的实现都放置在相应模块的impl下
类名
类名都以UpperCamelCase风格编写。
类名通常是名词或名词短语，接口名称有时可能是形容词或形容词短语。现在还没有特定的规则或行之有效的约定来命名注解类型。
名词，采用大驼峰命名法，尽量避免缩写，除非该缩写是众所周知的， 比如HTML,URL，如果类名称中包含单词缩写，则单词缩写的每个字母均应大写。
类 描述 例如
- Activity 类 Activity为后缀标识 欢迎页面类WelcomeActivity
- Adapter类 Adapter 为后缀标识 新闻详情适配器 NewDetailAdapter
- 解析类 Parser为后缀标识 首页解析类HomePosterParser
- 工具方法类 Util或Manager为后缀标识（与系统或第三方的Utils区分）或* * 功能+Util
- 线程池管理类：ThreadPoolManager
- 日志工具类：LogUtil（Logger也可）
- 打印工具类：PrinterUtil
- 数据库类 以DBHelper后缀标识 新闻* 数据库：NewDBHelper
- Service类 以Service为后缀标识
- 时间服务TimeServiceBroadcast
- Receiver类 以Receiver为后缀标识
- 推送接收JPushReceiver
- ContentProvider 以Provider为后缀标识
- 自定义的共享基础类 以Base开头 BaseActivity,BaseFragment
- 测试类的命名以它要测试的类的名称开始，以Test结束。
- 接口（interface）：命名规则与类一样采用大驼峰命名法，多以able或ible结尾
- 所有Model、View、Presenter的接口都以I为前缀，不加后缀，其他的接口采用上述命名规则。
方法名
方法名都以 LowerCamelCase 风格编写。
方法名通常是动词或动词短语。
方法 说明
- initXX() 初始化相关方法,使用init为前缀标识，如初始化布局initView()
- isXX() checkXX() 方法返回值为
- boolean型的请使用is或check为前缀标识
- getXX() 返回某个值的方法，使用get为前缀标识
- handleXX() 对数据进行处理的方法，尽量使用handle为前缀标识
- displayXX()/showXX() 弹出提示框和提示信息，使用display/show为前缀标识
- saveXX() 与保存数据相关的，使用save为前缀标识
- resetXX() 对数据重组的，使用reset前缀标识
- clearXX() 清除数据相关的
- removeXXX() 清除数据相关的
- drawXXX() 绘制数据或效果相关的，使用draw前缀标识
- 下划线可能出现在JUnit测试方法名称中用以分隔名称的逻辑组件。一个典型的模式是：test_，例如testPop_emptyStack。
并不存在唯一正确的方式来命名测试方法。
常量名
常量名命名模式为CONSTANT_CASE，全部字母大写，用下划线分隔单词。那，到底什么算是一个常量？
每个常量都是一个静态final字段，但不是所有静态final字段都是常量。在决定一个字段是否是一个常量时，考虑它是否真的感觉像是一个常量。
例如，如果任何一个该实例的观测状态是可变的，则它几乎肯定不会是一个常量。只是永远不打算改变对象一般是不够的，它要真的一直不变才能将它示为常量。
这些名字通常是名词或名词短语。
非常量字段名
非常量字段名以LowerCamelCase风格的基础上改造为如下风格：
基本结构为scopeVariableNameType，
- scope：范围
- 非公有，非静态字段命名以m开头。
- 静态字段命名以s开头。
- 公有非静态字段命名以p开头。
- 公有静态字段（全局变量）命名以g开头。
- public static final 字段(常量) 全部大写，并用下划线连起来。
使用1字符前缀来表示作用范围，1个字符的前缀必须小写，前缀后面是由表意性强的一个单词或多个单词组成的名字，而且每个单词的首写字母大写，其它字母小写，这样保证了对变量名能够进行正确的断句。
Type：类型
考虑到Android中使用很多UI控件，为避免控件和普通成员变量混淆以及更好达意，所有用来表示控件的成员变量统一加上控件缩写作为后缀（文末附有缩写表）。
对于普通变量一般不添加类型后缀，如果统一添加类型后缀，请参考文末的缩写表。
用统一的量词通过在结尾处放置一个量词，就可创建更加统一的变量，它们更容易理解，也更容易搜索。
注意：如果项目中使用ButterKnife，则不添加m前缀，以LowerCamelCase风格命名。
例如，请使用 mCustomerStrFirst 和 mCustomerStrLast，而不要使用mFirstCustomerStr和mLastCustomerStr。
量词列表：量词后缀说明
First 一组变量中的第一个
Last 一组变量中的最后一个
Next 一组变量中的下一个变量
Prev 一组变量中的上一个
Cur 一组变量中的当前变量。
说明：
集合添加如下后缀：List、Map、Set
数组添加如下后缀：Arr
参数名
参数名以LowerCamelCase风格编写
局部变量名
局部变量名以LowerCamelCase风格编写，比起其它类型的名称，局部变量名可以有更为宽松的缩写。
虽然缩写更宽松，但还是要避免用单字符进行命名，除了临时变量和循环变量。
即使局部变量是final和不可改变的，也不应该把它示为常量，自然也不能用常量的规则去命名它。
临时变量
临时变量通常被取名为
- i，j，k，m和n，它们一般用于整型；
- c，d，e，它们一般用于字符型。 如： for (int i = 0; i < len ; i++)，并且它和第一个单词间没有空格。
资源文件命名规范
资源布局文件（XML文件（layout布局文件））
全部小写，采用下划线命名法
- contentview 命名
必须以全部单词小写，单词间以下划线分割，使用名词或名词词组。
所有Activity或Fragment的contentView必须与其类名对应，对应规则为：
将所有字母都转为小写，将类型和功能调换（也就是后缀变前缀）。
例如：activity_main.xml - Dialog命名：dialog_描述.xml
例如：dialog_hint.xml - PopupWindow命名：ppw_描述.xml
例如：ppw_info.xml - 列表项命名：item_描述.xml
例如：item_city.xml - 包含项命名：模块(位置)描述.xml
例如：activity_main_head.xml、activity_main_bottom.xml
注意：通用的包含项命名采用：项目名称缩写描述.xml
例如：xxxx_title.xml
资源文件
全部小写，采用下划线命名法，加前缀区分
命名模式：可加后缀 small 表示小图, big 表示大图，逻辑名称可由多个单词加下划线组成，采用以下规则：
用途模块名逻辑名称
用途模块名颜色
用途逻辑名称
用途颜色
说明：用途也指控件类型（具体见UI控件缩写表）
例如：
btn_main_home.png 按键
divider_maket_white.png 分割线
ic_edit.png 图标
bg_main.png 背景
btn_red.png 红色按键
btn_red_big.png 红色大按键
ic_head_small.png 小头像
bg_input.png 输入框背景
divider_white.png 白色分割线
如果有多种形态如按钮等除外如 btn_xx.xml（selector）
名称 功能
btn_xx 按钮图片使用btn_整体效果（selector）
btn_xx_normal 按钮图片使用btn_正常情况效果
btn_xx_pressed 按钮图片使用btn_点击时候效果
btn_xx_focused state_focused聚焦效果
btn_xx_disabled state_enabled (false)不可用效果
btn_xx_checked state_checked选中效果
btn_xx_selected state_selected选中效果
btn_xx_hovered state_hovered悬停效果
btn_xx_checkable state_checkable可选效果
btn_xx_activated state_activated激活的
btn_xx_windowfocused state_window_focused
bg_head 背景图片使用bg_功能说明
def_search_cell 默认图片使用def功能说明
ic_more_help 图标图片使用ic功能说明
seg_list_line 具有分隔特征的图片使用seg功能说明
sel_ok 选择图标使用sel功能_说明
动画文件（anim文件夹下）
全部小写，采用下划线命名法，加前缀区分。
具体动画采用以下规则：
模块名_逻辑名称
逻辑名称
refresh_progress.xml
market_cart_add.xml
market_cart_remove.xml
普通的tween动画采用如下表格中的命名方式
// 前面为动画的类型，后面为方向
动画命名例子 规范写法
fade_in 淡入
fade_out 淡出
push_down_in 从下方推入
push_down_out 从下方推出
push_left 推向左方
slide_in_from_top 从头部滑动进入
zoom_enter 变形进入
slide_in 滑动进入
shrink_to_middle 中间缩小
- values中name命名
类别 命名 示例
strings strings的name命名使用下划线命名法，采用以下规则：模块名+逻辑名称 main_menu_about 主菜单按键文字friend_title 好友模块标题栏friend_dialog_del 好友删除提示login_check_email 登录验证
dialog_title 弹出框标题
button_ok 确认键 loading 加载文字
colors colors的name命名使用下划线命名法，采用以下规则：模块名+逻辑名称 颜色 friend_info_bg friend_bg transparent gray
styles styles的name命名使用 Camel命名法，采用以下规则：模块名+逻辑名称 main_tabBottom
layout中的id命名
命名模式为：view缩写_view的逻辑名称
使用 AndroidStudio 的插件 ButterKnife Zelezny，生成注解非常方便。
如果不使用 ButterKnife Zelezny，则建议使用 view 缩写做前缀缀，如：tv_username（展示用户名的TextView）
编程实践
@Override：能用则用
只要是合法的，就把@Override注解给用上。
捕获的异常：不能忽视
除了下面的例子，对捕获的异常不做响应是极少正确的。(典型的响应方式是打印日志，或者如果它被认为是不可能的，则把它当作一个 AssertionError 重新抛出。)
如果它确实是不需要在catch块中做任何响应，需要做注释加以说明(如下面的例子)。
try {
int i = Integer.parseInt(response);
return handleNumericResponse();
} catch (NumberFormatException ok){
// it's not numeric; that's fine, just continue
}
return handleTextResponse(response);
例外：在测试中，如果一个捕获的异常被命名为expected，则它可以被不加注释地忽略。下面是一种非常常见的情形，用以确保所测试的方法会抛出一个期望中的异常，因此在这里就没有必要加注释。
try {
emptyStack.pop();
fail();
} catch (NoSuchElementException expected) {
}
静态成员：使用类进行调用
使用类名调用静态的类成员，而不是具体某个对象或表达式。
Foo aFoo = ...;
Foo.aStaticMethod(); // good
aFoo.aStaticMethod(); // bad
somethingThatYieldsAFoo().aStaticMethod(); // very bad
注释Javadoc
格式
一般形式
Javadoc块的基本格式如下所示：
/**
* Multiple lines of Javadoc text are written here,
* wrapped normally...
*/
public int method(String p1) { ... }
或者是以下单行形式：
/** An especially shortbit of Javadoc. */
基本格式总是OK的。当整个Javadoc块能容纳于一行时,且没有Javadoc标可以使用单行形式。
段落
空行(即，只包含最左侧星号的行)会出现在段落之间和Javadoc标记(@XXX)之前(如果有的话)。
除了第一个段落，每个段落第一个单词前都有标签
，并且它和第一个单词间没有空格。
Javadoc标记
标准的Javadoc标记按以下顺序出现：@param, @return, @throws, @deprecated,
前面这4种标记如果出现，描述都不能为空。 当描述无法在一行中容纳，连续行需要至少再缩进4个空格。