数组初始化中，大括号内的空格是可选的，即new int[] {5, 6}和new int[] { 5, 6 }都是可以的

Note：这个规则并不要求或禁止一行的开关或结尾需要额外的空格，只对内部空格做要求。

以下示例先展示未对齐的代码，然后是对齐的代码：

1
2
3
4

private int x; // this is fine
private Color color; // this too
private int    x;         // permitted, but future edits
private Color  color;     // may leave it unaligned

Tip：对齐可增加代码可读性，但它为日后的维护带来问题。考虑未来某个时候，我们需要修改一堆对齐的代码中的一行。这可能导致原本很漂亮的对齐代码变得错位。很可能它会提示你调整周围代码的空白来使这一堆代码重新水平对齐(比如程序员想保持这种水平对齐的风格)。这就会让你做许多的无用功，增加了reviewer的工作并且可能导致更多的合并冲突。

我们没有理由假设读者能记住整个Java运算符优先级表。

没有方法和文档的枚举类可写成数组初始化的格式：

1
2
3
4
5
6

private enum Suit {
    CLUBS,
    HEARTS,
    SPADES,
    DIAMONDS
}

由于枚举类也是一个类，因此所有适用于其它类的格式规则也适用于枚举类。

1

@Nullable public String getNameIfPresent() { … }

例外：单个的注解可以和签名的第一行出现在同一行。

1

@Override public int hashCode() { … }

应用于字段的注解紧随文档块出现，应用于字段的多个注解允许与字段出现在同一行。

1

@Partial @Mock DataLoader loader;

参数和局部变量注解没有特定规则。

以下示例注释都是OK的。

1
2
3

/** This is // And so /* Or you can
 *  okay. // is this. * even do this. */
 */

注释不要封闭在由星号或其它字符绘制的框架里。

Tip：在写多行注释时，如果你希望在必要时能重新换行(即注释像段落风格一样)，那么使用/ … /。

public protected private abstract static final transient Volatile synchronized native strictfp

采用反域名命名规则，全部使用小写字母。一级包名为com，二级包名为xx（可以是公司或则个人的随便），三级包名根据应用进行命名，四级包名为模块名或层级名。

例如：com.jiashuangkuaizi.kitchen

注意：如果项目采用MVP，所有M、V、P抽取出来的接口都放置在相应模块的i包下，所有的实现都放置在相应模块的impl下

类名通常是名词或名词短语，接口名称有时可能是形容词或形容词短语。现在还没有特定的规则或行之有效的约定来命名注解类型。

名词，采用大驼峰命名法，尽量避免缩写，除非该缩写是众所周知的， 比如HTML,URL，如果类名称中包含单词缩写，则单词缩写的每个字母均应大写。

测试类的命名以它要测试的类的名称开始，以Test结束。

例如：HashTest 或 HashIntegrationTest。

接口（interface）：命名规则与类一样采用大驼峰命名法，多以able或ible结尾，如

interface Runnable ;
interface Accessible。

注意：如果项目采用MVP，所有Model、View、Presenter的接口都以I为前缀，不加后缀，其他的接口采用上述命名规则。

方法名通常是动词或动词短语。

下划线可能出现在JUnit测试方法名称中用以分隔名称的逻辑组件。一个典型的模式是：test_，例如testPop_emptyStack。

并不存在唯一正确的方式来命名测试方法。

每个常量都是一个静态final字段，但不是所有静态final字段都是常量。在决定一个字段是否是一个常量时，考虑它是否真的感觉像是一个常量。

例如，如果任何一个该实例的观测状态是可变的，则它几乎肯定不会是一个常量。只是永远不打算改变对象一般是不够的，它要真的一直不变才能将它示为常量。

1
2
3
4
5
6
7
8
9
10
11
12
13

// Constants
static final int NUMBER = 5;
static final ImmutableListNAMES = ImmutableList.of("Ed", "Ann");
static final Joiner COMMA_JOINER = Joiner.on(','); // because Joiner is immutable
static final SomeMutableType[] EMPTY_ARRAY = {};
enum SomeEnum { ENUM_CONSTANT }
// Not constants
static String nonFinal = "non-final";
final String nonStatic = "non-static";
static final SetmutableCollection = new HashSet();
static final ImmutableSetmutableElements = ImmutableSet.of(mutable);
static final Logger logger = Logger.getLogger(MyClass.getName());
static final String[] nonEmptyArray = {"these", "can", "change"};

这些名字通常是名词或名词短语。

基本结构为scopeVariableNameType，

scope：范围

非公有，非静态字段命名以m开头。

静态字段命名以s开头。

公有非静态字段命名以p开头。

公有静态字段（全局变量）命名以g开头。

public static final 字段(常量) 全部大写，并用下划线连起来。

1
2
3
4
5
6
7
8
9

public class MyClass {
       public static final int SOME_CONSTANT = 42;
       public int pField;
       private static MyClass sSingleton;
       int mPackagePrivate;
       private int mPrivate;
       protected int mProtected;
       public static int gField;
}

使用1字符前缀来表示作用范围，1个字符的前缀必须小写，前缀后面是由表意性强的一个单词或多个单词组成的名字，而且每个单词的首写字母大写，其它字母小写，这样保证了对变量名能够进行正确的断句。

Type：类型

考虑到Android中使用很多UI控件，为避免控件和普通成员变量混淆以及更好达意，所有用来表示控件的成员变量统一加上控件缩写作为后缀（文末附有缩写表）。

对于普通变量一般不添加类型后缀，如果统一添加类型后缀，请参考文末的缩写表。

用统一的量词通过在结尾处放置一个量词，就可创建更加统一的变量，它们更容易理解，也更容易搜索。

注意：如果项目中使用ButterKnife，则不添加m前缀，以LowerCamelCase风格命名。

例如，请使用 mCustomerStrFirst 和 mCustomerStrLast，而不要使用mFirstCustomerStr和mLastCustomerStr。

量词列表：量词后缀说明

First 一组变量中的第一个
Last 一组变量中的最后一个
Next 一组变量中的下一个变量
Prev 一组变量中的上一个
Cur 一组变量中的当前变量。

集合添加如下后缀：List、Map、Set

数组添加如下后缀：Arr

注意：所有的VO（值对象）统一采用标准的lowerCamelCase风格编写，所有的DTO（数据传输对象）就按照接口文档中定义的字段名编写。

虽然缩写更宽松，但还是要避免用单字符进行命名，除了临时变量和循环变量。

即使局部变量是final和不可改变的，也不应该把它示为常量，自然也不能用常量的规则去命名它。

临时变量通常被取名为i，j，k，m和n，它们一般用于整型；c，d，e，它们一般用于字符型。 如： for (int i = 0; i < len ; i++)，并且它和第一个单词间没有空格。

单个的大写字母，后面可以跟一个数字(如：E, T, X, T2)。
以类命名方式(4.2.2节)，后面加个大写的T(如：RequestT, FooBarT)。

例如：activity_main.xml

例如：dialog_hint.xml

例如：ppw_info.xml

例如：item_city.xml

例如：activity_main_head.xml、activity_mainbottom.xml
注意：通用的包含项命名采用：项目名称缩写描述.xml
例如：xxxx_title.xml

2.资源文件（图片drawable文件夹下）：