c、使用的第三方包的引用。每個(gè)頂級(jí)第三方包歸為一組。第三方包之間按ASCII碼排序。例如：android, com, junit, org, sun
重要的是，每個(gè)class都要按照一定的邏輯規(guī)律排序。當(dāng)被問及時(shí)，能夠解釋清楚為什么這樣排序。例如，新增加的成員方法，不是簡單地放在class代碼最后面，按日期排序不是按邏輯排序。
當(dāng)一個(gè)類有多個(gè)構(gòu)造函數(shù)，或者多個(gè)同名成員方法時(shí)，這些函數(shù)應(yīng)該寫在一起，不應(yīng)該被其他成員分開。
術(shù)語說明：塊狀結(jié)構(gòu)（block-like construct）指類、成員函數(shù)和構(gòu)造函數(shù)的實(shí)現(xiàn)部分（花括號(hào)中間部分）。注意，在后面的4.8.3.1節(jié)中講到數(shù)組初始化，所有的數(shù)組初始化都可以被認(rèn)為是一個(gè)塊狀結(jié)構(gòu)（非強(qiáng)制）。
花括號(hào)一般用在if, else, for, do, 和 while等語句。甚至當(dāng)它的實(shí)現(xiàn)為空或者只有一句話時(shí)，也需要使用。
d、如果右括號(hào)結(jié)束一個(gè)語句塊或者函數(shù)體、構(gòu)造函數(shù)體或者有命名的類體，則需要換行。例如，當(dāng)右括號(hào)后面接else或者逗號(hào)時(shí)，不應(yīng)該換行。
一些例外的情況，將在4.8.1節(jié)講枚舉類型的時(shí)候講到。
4.1.3 空語句塊：使代碼更簡潔
一個(gè)空的語句塊，可以在左花括號(hào)之后直接接右花括號(hào)，中間不需要空格或換行。但是當(dāng)一個(gè)由幾個(gè)語句塊聯(lián)合組成的語句塊時(shí)，則需要換行。（例如：if/else-if/else try/catch/finally）.
例子：
4.2 語句塊的縮進(jìn)：2空格
每當(dāng)一個(gè)新的語句塊產(chǎn)生，縮進(jìn)就增加兩個(gè)空格。當(dāng)這個(gè)語句塊結(jié)束時(shí)，縮進(jìn)恢復(fù)到上一層級(jí)的縮進(jìn)格數(shù)。縮進(jìn)要求對(duì)整個(gè)語句塊中的代碼和注釋都適用。（例子可參考之前4.1.2節(jié)中的例子）。
4.3 一行最多只有一句代碼
每句代碼的結(jié)束都需要換行。
4.4 行長度限制：80或100
不同的項(xiàng)目可以選擇采用80個(gè)字符或者100個(gè)字符作為限制。除了以下幾個(gè)特殊情況外，其他代碼內(nèi)容都需要遵守這個(gè)長度限制。這在4.5節(jié)會(huì)有詳細(xì)解釋。
例外：
a、按照行長度限制，無法實(shí)現(xiàn)地方（例如：javadoc中超長的URL地址， 或者一個(gè)超長的JSNI方法的引用）；
b、package和import語句不受長度限制。（見3.2、3.3節(jié)）；
c、注釋中的命令行指令行，將被直接復(fù)制到shell中執(zhí)行的。
4.5 長行斷行
術(shù)語說明：當(dāng)一行代碼按照其他規(guī)范都合法，只是為了避免超出行長度限制而換行時(shí)，稱為長行斷行。
長行斷行，沒有一個(gè)適合所有場景的全面、確定的規(guī)范。但很多相同的情況，我們經(jīng)常使用一些行之有效的斷行方法。
注意：將長行封裝為函數(shù)，或者使用局部變量的方法，也可以解決一些超出行長度限制的情況。并非一定要斷行。
4.5.1 在何處斷行
斷行的主要原則是：選擇在更高一級(jí)的語法邏輯的地方斷行。其他一些原則如下：
a、當(dāng)一個(gè)非賦值運(yùn)算的語句斷行時(shí)，在運(yùn)算符號(hào)之前斷行。（這與Google的C++規(guī)范和JavaScrip規(guī)范等其他規(guī)范不同）。
b、當(dāng)一個(gè)賦值運(yùn)算語句斷行時(shí)，一般在賦值符號(hào)之后斷行。但是也可以在之前斷行。
c、在調(diào)用函數(shù)或者構(gòu)造函數(shù)需要斷行時(shí)，與函數(shù)名相連的左括號(hào)要在一行。也就是在左括號(hào)之后斷行。
d、逗號(hào)斷行時(shí)，要和逗號(hào)隔開的前面的語句斷行。也就是在逗號(hào)之后斷行。
4.5.2 斷行的縮進(jìn)：至少4個(gè)字符
當(dāng)斷行之后，在第一行之后的行，我們叫做延續(xù)行。每一個(gè)延續(xù)行在第一行的基礎(chǔ)上至少縮進(jìn)四個(gè)字符。
當(dāng)原行之后有多個(gè)延續(xù)行的情況，縮進(jìn)可以大于4個(gè)字符。如果多個(gè)延續(xù)行之間由同樣的語法元素?cái)嘈校鼈兛梢圆捎孟嗤目s進(jìn)。
4.6.3節(jié)介紹水平對(duì)齊中，解決了使用多個(gè)空格與之前行縮進(jìn)對(duì)齊的問題。
4.6 空白空間
4.6.1 垂直空白
單行空行在以下情況使用：
a、類成員間需要空行隔開：例如成員變量、構(gòu)造函數(shù)、成員函數(shù)、內(nèi)部類、靜態(tài)初始化語句塊（static initializers）、實(shí)例初始化語句塊（instance initializers）。
例外：成員變量之間的空白行不是必需的。一般多個(gè)成員變量中間的空行，是為了對(duì)成員變量做邏輯上的分組。
b、在函數(shù)內(nèi)部，根據(jù)代碼邏輯分組的需要，設(shè)置空白行作為間隔。
c、類的第一個(gè)成員之前，或者最后一個(gè)成員結(jié)束之后，用空行間隔。（可選）
d、本文檔中其他部分介紹的需要空行的情況。（例如 3.3節(jié)中的import語句）
單空行時(shí)使用多行空行是允許的，但是不要求也不鼓勵(lì)。
4.6.2 水平空白
除了語法、其他規(guī)則、詞語分隔、注釋和javadoc外，水平的ASCII空格只在以下情況出現(xiàn)：
a、所有保留的關(guān)鍵字與緊接它之后的位于同一行的左括號(hào)之間需要用空格隔開。（例如if、for、catch）
b、所有保留的關(guān)鍵字與在它之前的右花括號(hào)之間需要空格隔開。（例如else、catch）
c、在左花括號(hào)之前都需要空格隔開。只有兩種例外：
@SomeAnnotation({a, b})
String[][] x = {{"foo"}};
d、所有的二元運(yùn)算符和三元運(yùn)算符的兩邊，都需要空格隔開。
e、逗號(hào)、冒號(hào)、分號(hào)和右括號(hào)之后，需要空格隔開。
f、// 雙斜線開始一行注釋時(shí)。雙斜線兩邊都應(yīng)該用空格隔開。并且可使用多個(gè)空格，但是不做強(qiáng)制要求。
g、變量聲明時(shí)，變量類型和變量名之間需要用空格隔開。
h、初始化一個(gè)數(shù)組時(shí)，花括號(hào)之間可以用空格隔開，也可以不使用。（例如：new int[] {5, 6} 和 new int[] { 5, 6 } 都可以）
注意：這一原則不影響一行開始或者結(jié)束時(shí)的空格。只針對(duì)行內(nèi)部字符之間的隔開。
4.6.3 水平對(duì)齊：不做強(qiáng)制要求
術(shù)語說明：水平對(duì)齊，是指通過添加多個(gè)空格，使本行的某一符號(hào)與上一行的某一符號(hào)上下對(duì)齊。
這種對(duì)齊是被允許的，但是不會(huì)做強(qiáng)制要求。
以下是沒有水平對(duì)齊和水平對(duì)齊的例子;
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
注意：水平對(duì)齊能夠增加代碼的可讀性，但是增加了未來維護(hù)代碼的難度?？紤]到維護(hù)時(shí)只需要改變一行代碼，之前的對(duì)齊可以不需要改動(dòng)。為了對(duì)齊，你更有可能改了一行代碼，同時(shí)需要更改附近的好幾行代碼，而這幾行代碼的改動(dòng)，可能又會(huì)引起一些為了保持對(duì)齊的代碼改動(dòng)。那原本這行改動(dòng)，我們稱之為“爆炸半徑”。這種改動(dòng)，在最壞的情況下可能會(huì)導(dǎo)致大量的無意義的工作，即使在最好的情況下，也會(huì)影響版本歷史信息，減慢代碼review的速度，引起更多merge代碼沖突的情況。
4.7 分組括號(hào)：建議使用
非必須的分組括號(hào)只有在編寫代碼者和代碼審核者都認(rèn)為大家不會(huì)因?yàn)闆]有它而導(dǎo)致代碼理解錯(cuò)誤的時(shí)候，或者它不會(huì)使代碼更易理解的時(shí)候才能省略。沒有理由認(rèn)為所有閱讀代碼的人都能記住所有java運(yùn)算符的優(yōu)先級(jí)。
4.8 特殊結(jié)構(gòu)
4.8.1 枚舉類型
每個(gè)逗號(hào)后接一個(gè)枚舉變量，不要求換行。
枚舉類型，如果沒有函數(shù)和javadoc，處理格式是可以按照數(shù)組初始化來處理。
例子：
private enum Suit { CLUBS, HEARTS, SPADES, DIAMONDS }
枚舉類型也是一種類（Class），因此Class類的其他格式要求，也適用于枚舉類型。
4.8.2 變量聲明
4.8.2.1 每次聲明一個(gè)變量
不要采用一個(gè)聲明，聲明多個(gè)變量。例如 int a, b;
4.8.2.2 當(dāng)需要時(shí)才聲明，盡快完成初始化
局部變量不應(yīng)該習(xí)慣性地放在語句塊的開始處聲明，而應(yīng)該盡量離它第一次使用的地方最近的地方聲明，以減小它們的使用范圍。
局部變量應(yīng)該在聲明的時(shí)候就進(jìn)行初始化。如果不能在聲明時(shí)初始化，也應(yīng)該盡快完成初始化。
4.8.3 數(shù)組
4.8.3.1 數(shù)組初始化：可以類似塊代碼處理
所有數(shù)組的初始化，都可以采用和塊代碼相同的格式處理。例如以下格式都是允許的：
4.8.3.2 不能像C風(fēng)格一樣聲明數(shù)組
方括號(hào)應(yīng)該是變量類型的一部分，因此不應(yīng)該和變量名放在一起。例如：應(yīng)該是String[] args，而不是 String args[] 。
4.8.4 switch語句
術(shù)語說明：switch語句是指在switch花括號(hào)中，包含了一組或多組語句塊。每組語句塊都由一個(gè)或多個(gè)switch標(biāo)簽（例如case FOO：或者 default：）打頭。
4.8.4.1 縮進(jìn)
和其他語句塊一樣，switch花括號(hào)之后縮進(jìn)兩個(gè)字符。
每個(gè)switch標(biāo)簽之后，后面緊接的非標(biāo)簽的新行，按照花括號(hào)相同的處理方式縮進(jìn)兩個(gè)字符。在標(biāo)簽結(jié)束后，恢復(fù)到之前的縮進(jìn)，類似花括號(hào)結(jié)束。
4.8.4.2 繼續(xù)向下執(zhí)行的注釋
在switch語句中，每個(gè)標(biāo)簽對(duì)應(yīng)的代碼執(zhí)行完后，都應(yīng)該通過語句結(jié)束（例如：break、continue、return 或拋出異常），否則應(yīng)該通過注釋說明，代碼需要繼續(xù)向下執(zhí)行下一個(gè)標(biāo)簽的代碼。注釋說明文字只要能說明代碼需要繼續(xù)往下執(zhí)行都可以（通常是 //fall through）。這個(gè)注釋在最后一個(gè)標(biāo)簽之后不需要注釋。例如：
4.8.4.3 default標(biāo)簽需要顯式聲明
每個(gè)switch語句中，都需要顯式聲明default標(biāo)簽。即使沒有任何代碼也需要顯示聲明。
4.8.5 Annotations
Annotations應(yīng)用到類、函數(shù)或者構(gòu)造函數(shù)時(shí)，應(yīng)緊接javadoc之后。每一行只有一個(gè)Annotations。
Annotations所在行不受行長度限制，也不需要增加縮進(jìn)。例如：
@Override
@Nullable
public String getNameIfPresent() { ... }
例外情況：
如果Annotations只有一個(gè)，并且不帶參數(shù)。則它可以和類或方法名放在同一行。例如：
@Override public int hashCode() { ... }
Annotations應(yīng)用到成員變量時(shí)，也是緊接javadoc之后。不同的是，多個(gè)annotations可以放在同一行。例如：
@Partial @Mock DataLoader loader;
對(duì)于參數(shù)或者局部變量使用Annotations的情況，沒有特定的規(guī)范。
4.8.6 注釋
4.8.6.1 語句塊的注釋風(fēng)格
注釋的縮進(jìn)與它所注釋的代碼縮進(jìn)相同?？梢圆捎?/* */ 進(jìn)行注釋，也可以用 // 進(jìn)行注釋。當(dāng)使用 /**/ 進(jìn)行多行注釋時(shí)，每一行都應(yīng)該以 * 開始， 并且 * 應(yīng)該上下對(duì)齊。
例如：
多行注釋時(shí)，如果你希望集成開發(fā)環(huán)境能自動(dòng)對(duì)齊注釋，你應(yīng)該使用 /**/， //一般不會(huì)自動(dòng)對(duì)齊。
4.8.7 修飾符
多個(gè)類和成員變量的修飾符，按Java Lauguage Specification中介紹的先后順序排序。具體是：
public protected private abstract static final transient volatile synchronized native strictfp
五、 命名
5.1 適用于所有命名標(biāo)識(shí)符的通用規(guī)范
標(biāo)示符只應(yīng)該使用ASCII字母、數(shù)字和下劃線，字母大小寫敏感。因此所有的標(biāo)示符，都應(yīng)該能匹配正則表達(dá)式 \w+ 。
Google Style中，標(biāo)示符不需要使用特殊的前綴或后綴，例如：name_, mName, s_name 和 kName。
5.2 不同類型的標(biāo)示符規(guī)范
5.2.1 包名
包名全部用小寫字母，通過 . 將各級(jí)連在一起。不應(yīng)該使用下劃線。
5.2.2 類名
類型的命名，采用以大寫字母開頭的大小寫字符間隔的方式（UpperCamelCase）。
class命名一般使用名詞或名詞短語。interface的命名有時(shí)也可以使用形容詞或形容詞短語。annotation沒有明確固定的規(guī)范。
測試類的命名，應(yīng)該以它所測試的類的名字為開頭，并在最后加上Test結(jié)尾。例如：HashTest 、 HashIntegrationTest。
5.2.3 方法名
方法命名，采用以小寫字母開頭的大小寫字符間隔的方式（lowerCamelCase）。
方法命名一般使用動(dòng)詞或者動(dòng)詞短語。
在JUnit的測試方法中，可以使用下劃線，用來區(qū)分測試邏輯的名字，經(jīng)常使用如下的結(jié)構(gòu)：test<MethodUnderTest>_<state> 。例如：testPop_emptyStack 。
測試方法也可以用其他方式進(jìn)行命名。
5.2.4 常量名
常量命名，全部使用大寫字符，詞與詞之間用下劃線隔開。（CONSTANCE_CASE）。
常量是一個(gè)靜態(tài)成員變量，但不是所有的靜態(tài)成員變量都是常量。在選擇使用常量命名規(guī)則給變量命名時(shí)，你需要明確這個(gè)變量是否是常量。例如，如果這個(gè)變量的狀態(tài)可以發(fā)生改變，那么這個(gè)變量幾乎可以肯定不是常量。只是計(jì)劃不會(huì)發(fā)生改變的變量不足以成為一個(gè)常量。下面是常量和非常量的例子：
常量一般使用名詞或者名詞短語命名。
5.2.5 非常量的成員變量名
非常量的成員變量命名（包括靜態(tài)變量和非靜態(tài)變量），采用lowerCamelCase命名。
一般使用名詞或名詞短語。
5.2.6 參數(shù)名
參數(shù)命名采用lowerCamelCase命名。
應(yīng)該避免使用一個(gè)字符作為參數(shù)的命名方式。
5.2.7 局部變量名
局部變量采用lowerCamelCase命名。它相對(duì)于其他類型的命名，可以采用更簡短寬松的方式。
但即使如此，也應(yīng)該盡量避免采用單個(gè)字母進(jìn)行命名的情況，除了在循環(huán)體內(nèi)使用的臨時(shí)變量。
即使局部變量是final、不可改變的，它也不能被認(rèn)為是常量，也不應(yīng)該采用常量的命名方式去命名。
5.2.8 類型名
類型名有兩種命名方式：
a、單獨(dú)一個(gè)大寫字母，有時(shí)后面再跟一個(gè)數(shù)字。（例如，E、T、X、T2）。
b、像一般的class命名一樣（見5.2.2節(jié)），再在最后接一個(gè)大寫字母。（例如，RequestT、FooBarT）。
5.3 Camel case的定義
有時(shí)一些短語被寫成Camel case的時(shí)候可以有多種寫法。例如一些縮寫詞匯，或者一些組合詞：IPv6 或者 iOS 等。
為了統(tǒng)一寫法，Google style給出了一種幾乎可以確定為一種的寫法。
a、將字符全部轉(zhuǎn)換為ASCII字符，并且去掉 ' 等符號(hào)。例如，"Müller's algorithm" 被轉(zhuǎn)換為 "Muellers algorithm" 。
b、將上一步轉(zhuǎn)換的結(jié)果拆分成一個(gè)一個(gè)的詞語。從空格處和從其他剩下的標(biāo)點(diǎn)符號(hào)處劃分。
注意：一些已經(jīng)是Camel case的詞語，也應(yīng)該在這個(gè)時(shí)候被拆分。（例如 AdWords 被拆分為 ad words）。但是例如iOS之類的詞語，它其實(shí)不是一個(gè)Camel case的詞語，而是人們慣例使用的一個(gè)詞語，因此不用做拆分。
c、經(jīng)過上面兩部后，先將所有的字母轉(zhuǎn)換為小寫，再把每個(gè)詞語的第一個(gè)字母轉(zhuǎn)換為大寫。
d、最后，將所有詞語連在一起，形成一個(gè)標(biāo)示符。
注意：詞語原來的大小寫規(guī)則，應(yīng)該被完全忽略。以下是一些例子：
* 號(hào)表示可以接受，但是不建議使用。
注意，有些詞語在英文中，可以用 - 連接使用，也可以不使用 - 直接使用。例如 “nonempty”和 “non-empty”都是可以的。因此，方法名字為checkNonempty 或者checkNonEmpty 都是可以的。
六、編程實(shí)踐
6.1 @override 都應(yīng)該使用
@override annotations只要是符合語法的，都應(yīng)該使用。
6.2 異常捕獲 不應(yīng)該被忽略
一般情況下，catch住的異常不應(yīng)該被忽略，而是都需要做適當(dāng)?shù)奶幚?。例如將錯(cuò)誤日志打印出來，或者如果認(rèn)為這種異常不會(huì)發(fā)生，則應(yīng)該作為斷言異常重新拋出。
如果這個(gè)catch住的異常確實(shí)不需要任何處理，也應(yīng)該通過注釋做出說明。例如：
例外：在測試類里，有時(shí)會(huì)針對(duì)方法是否會(huì)拋出指定的異常，這樣的異常是可以被忽略的。但是這個(gè)異常通常需要命名為： expected。例如：
6.3 靜態(tài)成員的訪問：應(yīng)該通過類，而不是對(duì)象
當(dāng)一個(gè)靜態(tài)成員被訪問時(shí)，應(yīng)該通過class名去訪問，而不應(yīng)該使用這個(gè)class的具體實(shí)例對(duì)象。例如：
6.4 不使用Finalizers 方法
重載Object的finalize方法是非常非常罕見的。
注意：不應(yīng)該使用這以方法。如果你認(rèn)為你必須使用，請(qǐng)先仔細(xì)閱讀并理解 Effective Java 第七條 “Avoid Finalizers”。然后不要使用它。
七、Javadoc
7.1 格式規(guī)范
7.1.1 通用格式
最基本的javadoc的通用格式如下例：
或者為單行格式：
通用格式在任何時(shí)候使用都是可以的。當(dāng)javadoc塊只有一行時(shí)，可以使用單行格式來替代通用格式。
7.1.2 段落
空白行：是指javadoc中，上下兩個(gè)段落之間只有上下對(duì)齊的 * 字符的行。每個(gè)段落的第一行在第一個(gè)字符之前，有一個(gè)<p>標(biāo)簽，并且之后不要有任何空格。
7.1.3 @從句
所有標(biāo)準(zhǔn)的@從句，應(yīng)該按照如下的順序添加：@param、@return、@throws、@deprecated。并且這四種@從句，不應(yīng)該出現(xiàn)在一個(gè)沒有描述的Javadoc塊中。
當(dāng)@從句無法在一行寫完時(shí)，應(yīng)該斷行。延續(xù)行在第一行的@字符的位置，縮進(jìn)至少4個(gè)字符單位。
7.2 摘要片段
每個(gè)類或者成員的javadoc，都是由一個(gè)摘要片段開始的。這個(gè)片段非常重要。因?yàn)樗穷惢蛘叻椒ㄔ谑褂脮r(shí)唯一能看到的文本說明。
主要摘要只是一個(gè)片段，應(yīng)該是一個(gè)名詞短語或者動(dòng)詞短語，而不應(yīng)該是一個(gè)完整的句子。但是它應(yīng)該像一個(gè)完整的句子一樣使用標(biāo)點(diǎn)符號(hào)。
注意：一種常見的錯(cuò)誤是以這種形式使用javadoc：/** @return the customer ID */.這是不對(duì)的。應(yīng)該改為：/** Returns the customer ID. */.
7.3 何處應(yīng)該使用Javadoc
至少，Javadoc應(yīng)該應(yīng)用于所有的public類、public和protected的成員變量和方法。和少量例外的情況。例外情況如下。
7.3.1 例外：方法本身已經(jīng)足夠說明的情況
當(dāng)方法本身很顯而易見時(shí)，可以不需要javadoc。例如：getFoo。沒有必要加上javadoc說明“Returns the foo”。
單元測試中的方法基本都能通過方法名，顯而易見地知道方法的作用。因此不需要增加javadoc。
注意：有時(shí)候不應(yīng)該引用此例外，來省略一些用戶需要知道的信息。例如：getCannicalName 。當(dāng)大部分代碼閱讀者不知道canonical name是什么意思時(shí)，不應(yīng)該省略Javadoc,認(rèn)為只能寫/** Returns the canonical name. */ 。
7.3.2 例外：重載方法
重載方法有時(shí)不需要再寫Javadoc。
7.3.3 例外：可選的javadoc
一些在包外不可見的class和成員變量或方法，根據(jù)需要，也可以使用javadoc。當(dāng)一個(gè)注釋用以說明這個(gè)類、變量或者方法的總體目標(biāo)或行為時(shí)，可以使用Javadoc。
轉(zhuǎn)載請(qǐng)注明出處：http://www.tkk7.com/zh-weir/archive/2014/02/08/409608.html