java的一些編碼風格學習,java語言編碼規範

本文目錄一覽：

• 1、Java幾種常見的編碼格式
• 2、java編碼規範有哪些？
• 3、Java新型技術有啥？
• 4、java編碼規範有哪些
• 5、java編程規範！！！

Java幾種常見的編碼格式

ASCII 碼

學過計算機的人都知道 ASCII 碼，總共有 128 個，用一個位元組的低 7 位表示，0~31 是控制字元如換行回車刪除等；32~126 是列印字元，可以通過鍵盤輸入並且能夠顯示出來。

ISO-8859-1

128 個字元顯然是不夠用的，於是 ISO 組織在 ASCII 碼基礎上又制定了一些列標準用來擴展 ASCII 編碼，它們是 ISO-8859-1~ISO-8859-15，其中 ISO-8859-1 涵蓋了大多數西歐語言字元，所有應用的最廣泛。ISO-8859-1 仍然是單位元組編碼，它總共能表示 256 個字元。

GB2312

它的全稱是《信息交換用漢字編碼字符集 基本集》，它是雙位元組編碼，總的編碼範圍是 A1-F7，其中從 A1-A9 是符號區，總共包含 682 個符號，從 B0-F7 是漢字區，包含 6763 個漢字。

GBK

全稱叫《漢字內碼擴展規範》，是國家技術監督局為 windows95 所制定的新的漢字內碼規範，它的出現是為了擴展 GB2312，加入更多的漢字，它的編碼範圍是 8140~FEFE（去掉 XX7F）總共有 23940 個碼位，它能表示 21003 個漢字，它的編碼是和 GB2312 兼容的，也就是說用 GB2312 編碼的漢字可以用 GBK 來解碼，並且不會有亂碼。

GB18030

全稱是《信息交換用漢字編碼字符集》，是我國的強制標準，它可能是單位元組、雙位元組或者四位元組編碼，它的編碼與 GB2312 編碼兼容，這個雖然是國家標準，但是實際應用系統中使用的並不廣泛。

UTF-16

說到 UTF 必須要提到 Unicode（Universal Code 統一碼），ISO 試圖想創建一個全新的超語言字典，世界上所有的語言都可以通過這本字典來相互翻譯。可想而知這個字典是多麼的複雜，關於 Unicode 的詳細規範可以參考相應文檔。Unicode 是 Java 和 XML 的基礎，下面詳細介紹 Unicode 在計算機中的存儲形式。

UTF-16 具體定義了 Unicode 字元在計算機中存取方法。UTF-16 用兩個位元組來表示 Unicode 轉化格式，這個是定長的表示方法，不論什麼字元都可以用兩個位元組表示，兩個位元組是 16 個 bit，所以叫 UTF-16。UTF-16 表示字元非常方便，每兩個位元組表示一個字元，這個在字元串操作時就大大簡化了操作，這也是 Java 以 UTF-16 作為內存的字元存儲格式的一個很重要的原因。

UTF-8

UTF-16 統一採用兩個位元組表示一個字元，雖然在表示上非常簡單方便，但是也有其缺點，有很大一部分字元用一個位元組就可以表示的現在要兩個位元組表示，存儲空間放大了一倍，在現在的網路帶寬還非常有限的今天，這樣會增大網路傳輸的流量，而且也沒必要。而 UTF-8 採用了一種變長技術，每個編碼區域有不同的字碼長度。不同類型的字元可以是由 1~6 個位元組組成。

UTF-8 有以下編碼規則：

如果一個位元組，最高位（第 8 位）為 0，表示這是一個 ASCII 字元（00 – 7F）。可見，所有 ASCII 編碼已經是 UTF-8 了。

如果一個位元組，以 11 開頭，連續的 1 的個數暗示這個字元的位元組數，例如：110xxxxx 代表它是雙位元組 UTF-8 字元的首位元組。

如果一個位元組，以 10 開始，表示它不是首位元組，需要向前查找才能得到當前字元的首位元組

Java 中需要編碼的場景

前面描述了常見的幾種編碼格式，下面將介紹 Java 中如何處理對編碼的支持，什麼場合中需要編碼。

I/O 操作中存在的編碼

我們知道涉及到編碼的地方一般都在字元到位元組或者位元組到字元的轉換上，而需要這種轉換的場景主要是在 I/O 的時候，這個 I/O 包括磁碟 I/O 和網路 I/O，關於網路 I/O 部分在後面將主要以 Web 應用為例介紹。

java編碼規範有哪些？

盡量使用完整的英文描述符，採用適用於相關領域的術語，採用大小寫混合使名字可讀。

JAVA代碼規範：

(1)類名首字母應該大寫。欄位、方法以及對象（句柄）的首字母應小寫。對於所有標識符，其中包含的所有單詞都應緊靠在一起，而且大寫中間單詞的首字母。例如：

ThisIsAClassName

thisIsMethodOrFieldName

若在定義中出現了常數初始化字元，則大寫static final基本類型標識符中的所有字母。這樣便可標誌出它們屬於編譯期的常數。Java包（Package）屬於一種特殊情況：它們全都是小寫字母，即便中間的單詞亦是如此。對於域名擴展名稱，如com，org，net或者edu等，全部都應小寫（這也是Java1.1和Java1.2的區別之一）。

(2)為了常規用途而創建一個類時，請採取”經典形式”，並包含對下述元素的定義：equals()

hashCode()

toString()

clone()（implement Cloneable）

implement Serializable

(3)對於自己創建的每一個類，都考慮置入一個main()，其中包含了用於測試那個類的代碼。為使用一個項目中的類，我們沒必要刪除測試代碼。若進行了任何形式的改動，可方便地返回測試。這些代碼也可作為如何使用類的一個示例使用。

(4)應將方法設計成簡要的、功能性單元，用它描述和實現一個不連續的類介面部分。理想情況下，方法應簡明扼要。若長度很大，可考慮通過某種方式將其分割成較短的幾個方法。這樣做也便於類內代碼的重複使用（有些時候，方法必須非常大，但它們仍應只做同樣的一件事情）。

(5)設計一個類時，請設身處地為客戶程序員考慮一下（類的使用方法應該是非常明確的）。然後，再設身處地為管理代碼的人考慮一下（預計有可能進行哪些形式的修改，想想用什麼方法可把它們變得更簡單）。

(6)使類儘可能短小精悍，而且只解決一個特定的問題。下面是對類設計的一些建議：

一個複雜的開關語句：考慮採用”多形”機制

數量眾多的方法涉及到類型差別極大的操作：考慮用幾個類來分別實現

許多成員變數在特徵上有很大的差別：考慮使用幾個類

(7)讓一切東西都儘可能地”私有”-private。可使庫的某一部分”公共化”（一個方法、類或者一個欄位等等），就永遠不能把它拿出。若強行拿出，就可能破壞其他人現有的代碼，使他們不得不重新編寫和設計。若只公布自己必須公布的，就可放心大膽地改變其他任何東西。在多線程環境中，隱私是特別重要的一個因素-只有private欄位才能在非同步使用的情況下受到保護。

(8)謹惕”巨大對象綜合症。對一些習慣於順序編程思維、且初涉OOP領域的新手，往往喜歡先寫一個順序執行的程序，再把它嵌入一個或兩個巨大的對象里。根據編程原理，對象表達的應該是應用程序的概念。

Java新型技術有啥？

1、DevOps (Docker and Jenkins)

過去的一年，越來越多的公司正在轉型DevOps,DevOps非常龐大，需要學習很多工具和原理，如果你是一個有經驗的Java程序員,願意學習環境管理、自動化和整體改進，你也可以成為DevOps工程師。

2、Java 9 – Java 15

相信現在很多Java開發人員主要使用的Java版本還是以Java 8為主，雖然Java 9 – Java 13已經推出了有一段時間。

但是作為Java程序員，我們可能因為某些原因沒辦法在線上環境真正的進行JDK的升級，但是花一些時間學習Java 9、Java 10、Java 11、Java 12和 Java 13的新特性還是有必要的。

另外，大家可以重點關注一些關鍵特性，如GC相關的特性、對編碼風格有改變的特性等。還有就是Java的LTS版本（Java 8、Java 11）要重點學習。

3、Spring Framework 5

2017年我們見證了Spring和Java生態系統的許多重大升級，Spring 5.0就是其中之一。 Spring 5 的新反應式編程模型、HTTP/2 支持，以及 Spring 通過 Kotlin 對函數式編程的全面支持這些都值得我們好好了解一下。

4、Spring Security 5.0

Spring Security 5.0 提供了許多新功能，並支持 Spring Framework 5.0，總共有 400 多個增強功能和 bug 修復。在Spring Security 5.0.0之前，密碼是明文保存，十分不安全。因為這一次發布的是大版本，所以我們決定使用更安全的密碼存儲方式。 Spring Security 5.0.0的主要亮點在於它只需要最小化的JDK 8、反應式安全特性、OAuth 2.0（OIDC）和現代密碼存儲。

5、Spring Boot 2

Spring Boot 2.0 基於 Spring 5 Framework ，提供了 非同步非阻塞 IO 的響應式 Stream 、非堵塞的函數式 Reactive Web 框架 Spring WebFlux等特性。很多使用過SpringBoot的人都知道，使用SpringBoot搭建Web應用真的是又快又好，相信Spring Boot 2會帶來更多驚喜。

6、Hadoop、Spark 和 Kafka

另外Java程序員需要學習的是大數據相關的知識。特別是Apache Spark 和 Kafka兩個框架。

7、Elasticsearch

全文搜索屬於最常見的需求，開源的 Elasticsearch （以下簡稱 Elastic）是目前全文搜索引擎的首選。維基百科、Stack Overflow、Github 都在使用它。

java編碼規範有哪些

這個就有點多了，可以借鑒比較成熟公司的編碼規範看看，一般規範，比如代碼命名規範，常量定義，集合處理，異常處理，注釋等等。

java編程規範！！！

名稱 Java語言編碼規範(Java Code Conventions)

　簡介 本文檔講述了Java語言的編碼規範，較之陳世忠先生《c++編碼規範》的浩繁詳盡，此文當屬短小精悍了。而其中所列之各項條款，從編碼風格，到注意事項，不單只Java，對於其他語言，也都很有借鑒意義。因為簡短，所以易記，大家不妨將此作為handbook，常備案頭，逐一對驗。

1 介紹

1.1 為什麼要有編碼規範

1.2 版權聲明

2 文件名

2.1 文件後綴

2.2 常用文件名

3 文件組織

3.1 Java源文件

3.1.1 開頭注釋

3.1.2 包和引入語句

3.1.3 類和介面聲明

4 縮進排版

4.1 行長度

4.2 換行

5 注釋

5.1 實現注釋的格式

5.1.1 塊注釋

5.1.2 單行注釋

5.1.3 尾端注釋

5.1.4 行末注釋

5.2 文擋注釋

6 聲明

6.1 每行聲明變數的數量

6.2 初始化

6.3 布局

6.4 類和介面的聲明

7 語句

7.1 簡單語句

7.2 複合語句

7.3 返回語句

7.4 if，if-else，if else-if else語句

7.5 for語句

7.6 while語句

7.7 do-while語句

7.8 switch語句

7.9 try-catch語句

8 空白

8.1 空行

8.2 空格

9 命名規範

10 編程慣例

10.1 提供對實例以及類變數的訪問控制

10.2 引用類變數和類方法

10.3 常量

10.4 變數賦值

10.5 其它慣例

10.5.1 圓括弧

10.5.2 返回值

10.5.3 條件運算符”?”前的表達式”?”前的表達式

10.5.4 特殊注釋

11 代碼範例

11.1 Java源文件範例

1 介紹(Introduction)

1.1 為什麼要有編碼規範(Why Have Code Conventions)

編碼規範對於程序員而言尤為重要，有以下幾個原因：

– 一個軟體的生命周期中，80%的花費在於維護

– 幾乎沒有任何一個軟體，在其整個生命周期中，均由最初的開發人員來維護

– 編碼規範可以改善軟體的可讀性，可以讓程序員儘快而徹底地理解新的代碼

– 如果你將源碼作為產品發布，就需要確任它是否被很好的打包並且清晰無誤，一如你已構建的其它任何產品

為了執行規範，每個軟體開發人員必須一致遵守編碼規範。每個人。

1.2 版權聲明(Acknowledgments)

本文檔反映的是Sun MicroSystems公司，Java語言規範中的編碼標準部分。主要貢獻者包括：Peter King，Patrick Naughton，Mike DeMoney，Jonni Kanerva，Kathy Walrath以及Scott Hommel。

本文檔現由Scott Hommel維護，有關評論意見請發至shommel@eng.sun.com

2 文件名(File Names)

這部分列出了常用的文件名及其後綴。

2.1 文件後綴(File Suffixes)

Java程序使用下列文件後綴：

文件類別 文件後綴

Java源文件 .java

Java位元組碼文件 .class

2.2 常用文件名(Common File Names)

常用的文件名包括：

文件名 用途

GNUmakefile makefiles的首選文件名。我們採用gnumake來創建（build）軟體。

README 概述特定目錄下所含內容的文件的首選文件名

3 文件組織(File Organization)

一個文件由被空行分割而成的段落以及標識每個段落的可選注釋共同組成。超過2000行的程序難以閱讀，應該盡量避免。”Java源文件範例”提供了一個布局合理的Java程序範例。

3.1 Java源文件(Java Source Files)

每個Java源文件都包含一個單一的公共類或介面。若私有類和介面與一個公共類相關聯，可以將它們和公共類放入同一個源文件。公共類必須是這個文件中的第一個類或介面。

Java源文件還遵循以下規則：

– 開頭注釋（參見”開頭注釋”）

– 包和引入語句（參見”包和引入語句”）

– 類和介面聲明（參見”類和介面聲明”）

3.1.1 開頭注釋(Beginning Comments)

所有的源文件都應該在開頭有一個C語言風格的注釋，其中列出類名、版本信息、日期和版權聲明：

/*

* Classname

*

* Version information

*

* Date

*

* Copyright notice

*/

3.1.2 包和引入語句(Package and Import Statements)

在多數Java源文件中，第一個非注釋行是包語句。在它之後可以跟引入語句。例如：

package java.awt;

import java.awt.peer.CanvasPeer;

3.1.3 類和介面聲明(Class and Interface Declarations)

下表描述了類和介面聲明的各個部分以及它們出現的先後次序。參見”Java源文件範例”中一個包含注釋的例子。

類/介面聲明的各部分 註解

1 類/介面文檔注釋(/**……*/) 該注釋中所需包含的信息，參見”文檔注釋”

2 類或介面的聲明

3 類/介面實現的注釋(/*……*/)如果有必要的話 該注釋應包含任何有關整個類或介面的信息，而這些信息又不適合作為類/介面文檔注釋。

4 類的(靜態)變數 首先是類的公共變數，隨後是保護變數，再後是包一級別的變數(沒有訪問修飾符，access modifier)，最後是私有變數。

5 實例變數 首先是公共級別的，隨後是保護級別的，再後是包一級別的(沒有訪問修飾符)，最後是私有級別的。

6 構造器

7 方法 這些方法應該按功能，而非作用域或訪問許可權，分組。例如，一個私有的類方法可以置於兩個公有的實例方法之間。其目的是為了更便於閱讀和理解代碼。

4 縮進排版(Indentation)

4個空格常被作為縮進排版的一個單位。縮進的確切解釋並未詳細指定(空格 vs. 製表符)。一個製表符等於8個空格(而非4個)。

4.1 行長度(Line Length)

盡量避免一行的長度超過80個字元，因為很多終端和工具不能很好處理之。

注意：用於文檔中的例子應該使用更短的行長，長度一般不超過70個字元。

4.2 換行(Wrapping Lines)

當一個表達式無法容納在一行內時，可以依據如下一般規則斷開之：

– 在一個逗號後面斷開

– 在一個操作符前面斷開

– 寧可選擇較高級別(higher-level)的斷開，而非較低級別(lower-level)的斷開

– 新的一行應該與上一行同一級別表達式的開頭處對齊

– 如果以上規則導致你的代碼混亂或者使你的代碼都堆擠在右邊，那就代之以縮進8個空格。

以下是斷開方法調用的一些例子：

someMethod(longExpression1, longExpression2, longExpression3,

longExpression4, longExpression5);

var = someMethod1(longExpression1,

someMethod2(longExpression2,

longExpression3));

以下是兩個斷開算術表達式的例子。前者更好，因為斷開處位於括弧表達式的外邊，這是個較高級別的斷開。

longName1 = longName2 * (longName3 + longName4 – longName5)

+ 4 * longname6; //PREFFER

longName1 = longName2 * (longName3 + longName4

– longName5) + 4 * longname6; //AVOID

以下是兩個縮進方法聲明的例子。前者是常規情形。後者若使用常規的縮進方式將會使第二行和第三行移得很靠右，所以代之以縮進8個空格

//CONVENTIONAL INDENTATION

someMethod(int anArg, Object anotherArg, String yetAnotherArg,

Object andStillAnother) {

…

}

//INDENT 8 SPACES TO AVOID VERY DEEP INDENTS

private static synchronized horkingLongMethodName(int anArg,

Object anotherArg, String yetAnotherArg,

Object andStillAnother) {

…

}

if語句的換行通常使用8個空格的規則，因為常規縮進(4個空格)會使語句體看起來比較費勁。比如：

//DON』T USE THIS INDENTATION

if ((condition1 condition2)

|| (condition3 condition4)

||!(condition5 condition6)) { //BAD WRAPS

doSomethingAboutIt(); //MAKE THIS LINE EASY TO MISS

}

//USE THIS INDENTATION INSTEAD

if ((condition1 condition2)

|| (condition3 condition4)

||!(condition5 condition6)) {

doSomethingAboutIt();

}

//OR USE THIS

if ((condition1 condition2) || (condition3 condition4)

||!(condition5 condition6)) {

doSomethingAboutIt();

}

這裡有三種可行的方法用於處理三元運算表達式：

alpha = (aLongBooleanExpression) ? beta : gamma;

alpha = (aLongBooleanExpression) ? beta

: gamma;

alpha = (aLongBooleanExpression)

? beta

: gamma;

5 注釋(Comments)

Java程序有兩類注釋：實現注釋(implementation comments)和文檔注釋(document comments)。實現注釋是那些在C++中見過的，使用/*…*/和//界定的注釋。文檔注釋(被稱為”doc comments”)是Java獨有的，並由/**…*/界定。文檔注釋可以通過javadoc工具轉換成HTML文件。

實現注釋用以注釋代碼或者實現細節。文檔注釋從實現自由(implementation-free)的角度描述代碼的規範。它可以被那些手頭沒有源碼的開發人員讀懂。

注釋應被用來給出代碼的總括，並提供代碼自身沒有提供的附加信息。注釋應該僅包含與閱讀和理解程序有關的信息。例如，相應的包如何被建立或位於哪個目錄下之類的信息不應包括在注釋中。

在注釋里，對設計決策中重要的或者不是顯而易見的地方進行說明是可以的，但應避免提供代碼中己清晰表達出來的重複信息。多餘的的注釋很容易過時。通常應避免那些代碼更新就可能過時的注釋。

注意：頻繁的注釋有時反映出代碼的低質量。當你覺得被迫要加註釋的時候，考慮一下重寫代碼使其更清晰。

注釋不應寫在用星號或其他字元畫出來的大框里。注釋不應包括諸如製表符和回退符之類的特殊字元。

5.1 實現注釋的格式(Implementation Comment Formats)

程序可以有4種實現注釋的風格：塊(block)、單行(single-line)、尾端(trailing)和行末(end-of-line)。

5.1.1 塊注釋(Block Comments)

塊注釋通常用於提供對文件，方法，數據結構和演算法的描述。塊注釋被置於每個文件的開始處以及每個方法之前。它們也可以被用於其他地方，比如方法內部。在功能和方法內部的塊注釋應該和它們所描述的代碼具有一樣的縮進格式。

塊注釋之首應該有一個空行，用於把塊注釋和代碼分割開來，比如：

/*

* Here is a block comment.

*/

塊注釋可以以/*-開頭，這樣indent(1)就可以將之識別為一個代碼塊的開始，而不會重排它。

/*-

* Here is a block comment with some very special

* formatting that I want indent(1) to ignore.

*

* one

* two

* three

*/

注意：如果你不使用indent(1)，就不必在代碼中使用/*-，或為他人可能對你的代碼運行indent(1)作讓步。

參見”文檔注釋”

5.1.2 單行注釋(Single-Line Comments)

短注釋可以顯示在一行內，並與其後的代碼具有一樣的縮進層級。如果一個注釋不能在一行內寫完，就該採用塊注釋(參見”塊注釋”)。單行注釋之前應該有一個空行。以下是一個Java代碼中單行注釋的例子：

if (condition) {

/* Handle the condition. */

…

}

5.1.3 尾端注釋(Trailing Comments)

極短的注釋可以與它們所要描述的代碼位於同一行，但是應該有足夠的空白來分開代碼和注釋。若有多個短注釋出現於大段代碼中，它們應該具有相同的縮進。

以下是一個Java代碼中尾端注釋的例子：

if (a == 2) {

return TRUE; /* special case */

} else {

return isPrime(a); /* works only for odd a */

}

5.1.4 行末注釋(End-Of-Line Comments)

注釋界定符”//”，可以注釋掉整行或者一行中的一部分。它一般不用於連續多行的注釋文本；然而，它可以用來注釋掉連續多行的代碼段。以下是所有三種風格的例子：

if (foo 1) {

// Do a double-flip.

…

}

else {

return false; // Explain why here.

}

//if (bar 1) {

//

// // Do a triple-flip.

// …

//}

//else {

// return false;

//}

5.2 文檔注釋(Documentation Comments)

注意：此處描述的注釋格式之範例，參見”Java源文件範例”

若想了解更多，參見”How to Write Doc Comments for Javadoc”，其中包含了有關文檔注釋標記的信息(@return, @param, @see)：

若想了解更多有關文檔注釋和javadoc的詳細資料，參見javadoc的主頁：

文檔注釋描述Java的類、介面、構造器，方法，以及欄位(field)。每個文檔注釋都會被置於注釋定界符/**…*/之中，一個注釋對應一個類、介面或成員。該注釋應位於聲明之前：

/**

* The Example class provides …

*/

public class Example { …

注意頂層(top-level)的類和介面是不縮進的，而其成員是縮進的。描述類和介面的文檔注釋的第一行(/**)不需縮進；隨後的文檔注釋每行都縮進1格(使星號縱向對齊)。成員，包括構造函數在內，其文檔注釋的第一行縮進4格，隨後每行都縮進5格。

若你想給出有關類、介面、變數或方法的信息，而這些信息又不適合寫在文檔中，則可使用實現塊注釋(見5.1.1)或緊跟在聲明後面的單行注釋(見5.1.2)。例如，有關一個類實現的細節，應放入緊跟在類聲明後面的實現塊注釋中，而不是放在文檔注釋中。

文檔注釋不能放在一個方法或構造器的定義塊中，因為Java會將位於文檔注釋之後的第一個聲明與其相關聯。

6 聲明(Declarations)

6.1 每行聲明變數的數量(Number Per Line)

推薦一行一個聲明，因為這樣以利於寫注釋。亦即，

int level; // indentation level

int size; // size of table

要優於，

int level, size;

不要將不同類型變數的聲明放在同一行，例如：

int foo, fooarray[]; //WRONG!

注意：上面的例子中，在類型和標識符之間放了一個空格，另一種被允許的替代方式是使用製表符：

int level; // indentation level

int size; // size of table

Object currentEntry; // currently selected table entry

6.2 初始化(Initialization)

盡量在聲明局部變數的同時初始化。唯一不這麼做的理由是變數的初始值依賴於某些先前發生的計算。

6.3 布局(Placement)

只在代碼塊的開始處聲明變數。（一個塊是指任何被包含在大括弧”{“和”}”中間的代碼。）不要在首次用到該變數時才聲明之。這會把注意力不集中的程序員搞糊塗，同時會妨礙代碼在該作用域內的可移植性。

void myMethod() {

int int1 = 0; // beginning of method block

if (condition) {

int int2 = 0; // beginning of “if” block

…

}

}

該規則的一個例外是for循環的索引變數

for (int i = 0; i maxLoops; i++) { … }

避免聲明的局部變數覆蓋上一級聲明的變數。例如，不要在內部代碼塊中聲明相同的變數名：

int count;

…

myMethod() {

if (condition) {

int count = 0; // AVOID!

…

}

…

}

6.4 類和介面的聲明(Class and Interface Declarations)

當編寫類和介面是，應該遵守以下格式規則：

– 在方法名與其參數列表之前的左括弧”(“間不要有空格

– 左大括弧”{“位於聲明語句同行的末尾

– 右大括弧”}”另起一行，與相應的聲明語句對齊，除非是一個空語句，”}”應緊跟在”{“之後

class Sample extends Object {

int ivar1;

int ivar2;

Sample(int i, int j) {

ivar1 = i;

ivar2 = j;

}

int emptyMethod() {}

…

}

– 方法與方法之間以空行分隔

7 語句(Statements)

7.1 簡單語句(Simple Statements)

每行至多包含一條語句，例如：

argv++; // Correct

argc–; // Correct

argv++; argc–; // AVOID!

7.2 複合語句(Compound Statements)

複合語句是包含在大括弧中的語句序列，形如”{ 語句 }”。例如下面各段。

– 被括其中的語句應該較之複合語句縮進一個層次

– 左大括弧”{“應位於複合語句起始行的行尾；右大括弧”}”應另起一行並與複合語句首行對齊。

– 大括弧可以被用於所有語句，包括單個語句，只要這些語句是諸如if-else或for控制結構的一部分。這樣便於添加語句而無需擔心由於忘了加括弧而引入bug。

7.3 返回語句(return Statements)

一個帶返回值的return語句不使用小括弧”()”，除非它們以某種方式使返回值更為顯見。例如：

return;

return myDisk.size();

return (size ? size : defaultSize);

7.4 if，if-else，if else-if else語句(if, if-else, if else-if else Statements)

if-else語句應該具有如下格式：

if (condition) {

statements;

}

if (condition) {

statements;

} else {

statements;

}

if (condition) {

statements;

} else if (condition) {

statements;

} else{

statements;

}

注意：if語句總是用”{“和”}”括起來，避免使用如下容易引起錯誤的格式：

if (condition) //AVOID! THIS OMITS THE BRACES {}!

statement;

7.5 for語句(for Statements)

一個for語句應該具有如下格式：

for (initialization; condition; update) {

statements;

}

一個空的for語句(所有工作都在初始化，條件判斷，更新子句中完成）應該具有如下格式：

for (initialization; condition; update);

當在for語句的初始化或更新子句中使用逗號時，避免因使用三個以上變數，而導致複雜度提高。若需要，可以在for循環之前(為初始化子句)或for循環末尾(為更新子句)使用單獨的語句。

7.6 while語句(while Statements)

一個while語句應該具有如下格式

while (condition) {

statements;

}

一個空的while語句應該具有如下格式：

while (condition);

7.7 do-while語句(do-while Statements)

一個do-while語句應該具有如下格式：

do {

statements;

} while (condition);

7.8 switch語句(switch Statements)

一個switch語句應該具有如下格式：

switch (condition) {

case ABC:

statements;

/* falls through */

case DEF:

statements;

break;

case XYZ:

statements;

break;

default:

statements;

break;

}

每當一個case順著往下執行時(因為沒有break語句)，通常應在break語句的位置添加註釋。上面的示例代碼中就包含注釋/* falls through */。

7.9 try-catch語句(try-catch Statements)

一個try-catch語句應該具有如下格式：

try {

statements;

} catch (ExceptionClass e) {

statements;

}

一個try-catch語句後面也可能跟著一個finally語句，不論try代碼塊是否順利執行完，它都會被執行。

try {

statements;

} catch (ExceptionClass e) {

statements;

} finally {

statements;

}

8 空白(White Space)

8.1 空行(Blank Lines)

空行將邏輯相關的代碼段分隔開，以提高可讀性。

下列情況應該總是使用兩個空行：

– 一個源文件的兩個片段(section)之間

– 類聲明和介面聲明之間

下列情況應該總是使用一個空行：

– 兩個方法之間

– 方法內的局部變數和方法的第一條語句之間

– 塊注釋（參見”5.1.1″）或單行注釋（參見”5.1.2″）之前

– 一個方法內的兩個邏輯段之間，用以提高可讀性

8.2 空格(Blank Spaces)

下列情況應該使用空格：

– 一個緊跟著括弧的關鍵字應該被空格分開，例如：

while (true) {

…

}

注意：空格不應該置於方法名與其左括弧之間。這將有助於區分關鍵字和方法調用。

– 空白應該位於參數列表中逗號的後面

– 所有的二元運算符，除了”.”，應該使用空格將之與操作數分開。一元操作符和操作數之間不因該加空格，比如：負號(“-“)、自增(“++”)和自減(“–“)。例如：

a += c + d;

a = (a + b) / (c * d);

while (d++ = s++) {

n++;

}

printSize(“size is ” + foo + “\n”);

– for語句中的表達式應該被空格分開，例如：

for (expr1; expr2; expr3)

– 強制轉型後應該跟一個空格，例如：

myMethod((byte) aNum, (Object) x);

myMethod((int) (cp + 5), ((int) (i + 3)) + 1);

9 命名規範(Naming Conventions)

命名規範使程序更易讀，從而更易於理解。它們也可以提供一些有關標識符功能的信息，以助於理解代碼，例如，不論它是一個常量，包，還是類。

標識符類型 命名規則 例子

包(Packages) 一個唯一包名的前綴總是全部小寫的ASCII字母並且是一個頂級域名，通常是com，edu，gov，mil，net，org，或1981年ISO 3166標準所指定的標識國家的英文雙字元代碼。包名的後續部分根據不同機構各自內部的命名規範而不盡相同。這類命名規範可能以特定目錄名的組成來區分部門(department)，項目(project)，機器(machine)，或註冊名(login names)。 com.sun.eng

com.apple.quicktime.v2

edu.cmu.cs.bovik.cheese

類(Classes) 命名規則：類名是個一名詞，採用大小寫混合的方式，每個單詞的首字母大寫。盡量使你的類名簡潔而富於描述。使用完整單詞，避免縮寫詞(除非該縮寫詞被更廣泛使用，像URL，HTML) class Raster;

class ImageSprite;

介面(Interfaces) 命名規則：大小寫規則與類名相似 interface RasterDelegate;

interface Storing;

方法(Methods) 方法名是一個動詞，採用大小寫混合的方式，第一個單詞的首字母小寫，其後單詞的首字母大寫。 run();

runFast();

getBackground();

變數(Variables) 除了變數名外，所有實例，包括類，類常量，均採用大小寫混合的方式，第一個單詞的首字母小寫，其後單詞的首字母大寫。變數名不應以下劃線或美元符號開頭，儘管這在語法上是允許的。

變數名應簡短且富於描述。變數名的選用應該易於記憶，即，能夠指出其用途。盡量避免單個字元的變數名，除非是一次性的臨時變數。臨時變數通常被取名為i，j，k，m和n，它們一般用於整型；c，d，e，它們一般用於字元型。 char c;

int i;

float myWidth;

實例變數(Instance Variables) 大小寫規則和變數名相似，除了前面需要一個下劃線 int _employeeId;

String _name;

Customer _customer;

常量(Constants) 類常量和ANSI常量的聲明，應該全部大寫，單詞間用下劃線隔開。(盡量避免ANSI常量，容易引起錯誤) static final int MIN_WIDTH = 4;

static final int MAX_WIDTH = 999;

static final int GET_THE_CPU = 1;

10 編程慣例(Programming Practices)

10.1 提供對實例以及類變數的訪問控制(Providing Access to Instance and Class Variables)

若沒有足夠理由，不要把實例或類變數聲明為公有。通常，實例變數無需顯式的設置(set)和獲取(gotten)，通常這作為方法調用的邊緣效應 (side effect)而產生。

一個具有公有實例變數的恰當例子，是類僅作為數據結構，沒有行為。亦即，若你要使用一個結構(struct)而非一個類(如果java支持結構的話)，那麼把類的實例變數聲明為公有是合適的。