Google Java编码风格

前言

1 源文件

UTF-8

\b

\u221e

import java.util.*

com.google

com

junit

org

java

javax

2 格式

int hello() { //左大括号之前不换行，之后换行
　　//函数体中若是语句等的终止，右大括号后换行，否则不换行
if (xxx) {
//do something
}

if (xxx) {
//do something
} else {
//do other thing
}
}　//右大括号前换行

if

for

catch

else

@AnnotationXXX ({a,b})

<T extends Foo & Bar>

, : ;　)

int a,b

new int[] {
0, 1, 2, 3
}

new int[] {
0, 1
2, 3
}

default:

switch (intput) {
case 1:
case 2:
xxx;
//fall through
case 3:
xxx;
break;
default:
xxx;
}

＠Override
@Nullable
public String get() {
...
}
//只要是合法的，重写＠Override的注解能用则用

//例外: 单个注解可和函数签名第一行出现在同一行中
@Override public int hashCode() {
...
}

//用于字段的注解随文档块出现，也可允许出现在同一行
@XXX @YYY DataLoader loader;

/**
* 用于描述方法或类
*/

/** 单行形式，一般用于描述类的变量 */

//　用于描述方法内部的单个语句

<p>

@param

@return

@throws

@deprecated

/** get xxx*/

/** @return xxx*/

/**
* A mutable sequence of characters.  This class provides an API compatible
* with <code>StringBuffer</code>, but with no guarantee of synchronization.
* This class is designed for use as a drop-in replacement for
* <code>StringBuffer</code> in places where the string buffer was being
* used by a single thread (as is generally the case).   Where possible,
* it is recommended that this class be used in preference to
* <code>StringBuffer</code> as it will be faster under most implementations.
*
* <p>
* For example, if <code>z</code> refers to a string builder object
* whose current contents are "<code>start</code>", then
* the method call <code>z.append("le")</code> would cause the string
* builder to contain "<code>startle</code>", whereas
* <code>z.insert(4, "le")</code> would alter the string builder to
* contain "<code>starlet</code>".
*
* @author      Michael McCloskey
* @see         java.lang.StringBuffer
* @see         java.lang.String
* @since       1.5
*/
public final class StringBuilder
extends AbstractStringBuilder
implements java.io.Serializable, CharSequence
{

/** use serialVersionUID for interoperability */
static final long serialVersionUID = 4383685877147921099L;

/**
* Constructs a string builder with no characters in it and an
* initial capacity of 16 characters.
*/
public StringBuilder() {
super(16);
}

/**
* Constructs a string builder with no characters in it and an
* initial capacity specified by the <code>capacity</code> argument.
*
* @param      capacity  the initial capacity.
* @throws     NegativeArraySizeException  if the <code>capacity</code>
*               argument is less than <code>0</code>.
*/
public StringBuilder(int capacity) {
super(capacity);
}

try {
xxx;
fail();
} catch (NoSuchElementException expected) {
}

3 命名

\W+

mName

s_name

name_

public protected private abstract static final transient volatile synchronized
native strictfp

CONSTANT_CASE

//Constants
static final int NUMBER = 5;
static final Joiner COMMA_JOINER ＝ Joiner.on(','); //immutable Joiner
static final Immutable<String> NAMES = ImmutableList.of("Ed", "Ann");
enum SomeEnum { ENUM_CONS }
static final SomeType[] EMPTY_ARRAY = []; //不变类

//Not constants
static String nonfinal = "non-final";
final String nonstatic = "non-static";
static final Set<String> mutableCollection = new HashSet<String>();
static final String[] nonEmptyArray = {"these", "can", "change"};
static final ImmutableSet<XXX> mutableElements = ImmutableSet.of(mutable);
static final Logger logger = Logger.getLogger(MyClass.getName());

UpperCamelCase

Test

lowerCamelCase

参考