【文章內(nèi)容簡介】 ....................................3410 縮寫說明 ................................................................................................................................3511 參考資料 ................................................................................................................................36 JAVA 代碼規(guī)范 7 1 介紹 為什么要有編碼規(guī)范編碼規(guī)范對于程序員而言尤為重要，有以下幾個(gè)原因：? 一個(gè)軟件產(chǎn)品的 80%的生命期是在維護(hù)。? 幾乎沒有一個(gè)軟件在它的整個(gè)生命期里都是被它的作者來維護(hù)的。 ? 使用好的風(fēng)格提高了軟件的可維護(hù)性。 ? 如果源代碼和軟件產(chǎn)品是捆綁給客戶的，作為產(chǎn)品的剩余部分，它應(yīng)該有好的分包（wellpackaged） ，足夠清晰和專業(yè)的代碼。 2 通用代碼格式一個(gè)文件由被空行分割而成的段落以及標(biāo)識(shí)每個(gè)段落的可選注釋共同組成。超過 2022 行的程序難以閱讀，應(yīng)該盡量避免。Java 源文件必須遵循以下規(guī)則：? 文件頭部注釋所有的源文件都應(yīng)該在開頭有一個(gè) C 語言風(fēng)格的注釋，其中列出文件名、作者、公司、日期、描述、修改說明和版權(quán)聲明：/** File: * Author: wangxie* Version: * Date: 06/04/2022* Modify:* Description:* Copyright notice*/? 包和引入語句在 Java 源文件中，第一個(gè)非注釋行是 Package 語句。Package 行要在 Import 行之前， Import 中標(biāo)準(zhǔn)的包名要在本地的包名之前，而且按照字母順序排列。例如： package 。 import 。 import 。 import 。 JAVA 代碼規(guī)范 8 ? 類和接口聲明下表描述了類和接口聲明的各個(gè)部分以及它們出現(xiàn)的先后次序。序號 類/接口聲明的各部分 注解1 類/接口文檔注釋(/**……*/) 該注釋中所需包含的信息。2 類或接口的聲明 3類/接口實(shí)現(xiàn)的注釋(/*……*/)如果有必要的話該注釋應(yīng)包含任何有關(guān)整個(gè)類或接口的信息，而這些信息又不適合作為類/接口文檔注釋。4 類的(靜態(tài)) 變量 首先是類的公共變量，隨后是保護(hù)變量，再后是包一級別的變量(沒有訪問修飾符，access modifier)，最后是私有變量。5 實(shí)例變量 首先是公共級別的，隨后是保護(hù)級別的，再后是包一級別的(沒有訪問修飾符)，最后是私有級別的。6 構(gòu)造器 7 方法這些方法應(yīng)該按功能，而非作用域或訪問權(quán)限，分組。例如，一個(gè)私有的類方法可以置于兩個(gè)公有的實(shí)例方法之間。其目的是為了更便于閱讀和理解代碼。4 個(gè)空格常被作為縮進(jìn)排版的一個(gè)單位，以表示縮進(jìn)，顯示程序的層次級別，增加程序的可讀性。不要在源代碼中保留 tab 字符，這是因?yàn)?tab 字符會(huì)隨著不同用戶的不同設(shè)置和不同的資源管理工具（打印、文檔、版本控制等）而代表不同的寬度。盡量避免一行的長度超過 80 個(gè)字符，因?yàn)楹芏嘟K端和工具不能很好處理之。注意：用于文檔中的例子應(yīng)該使用更短的行長，長度一般不超過 70 個(gè)字符。當(dāng)一個(gè)表達(dá)式無法容納在一行內(nèi)時(shí)，可以依據(jù)如下一般規(guī)則斷開之：? 在一個(gè)逗號后面斷開? 在一個(gè)操作符前面斷開? 寧可選擇較高級別(higherlevel)的斷開，而非較低級別(lowerlevel)的斷開? 新的一行應(yīng)該與上一行同一級別表達(dá)式的開頭處對齊? 如果以上規(guī)則導(dǎo)致你的代碼混亂或者使你的代碼都堆擠在右邊，那就代之以縮進(jìn) 8 個(gè)空格。 以下是斷開方法調(diào)用的一些例子： someMethod(longExpression1, longExpression2, longExpression3, JAVA 代碼規(guī)范 9 longExpression4, longExpression5)。 var = someMethod1(longExpression1, 　 someMethod2(longExpression2, longExpression3))。 以下是兩個(gè)斷開算術(shù)表達(dá)式的例子。前者更好，因?yàn)閿嚅_處位于括號表達(dá)式的外邊，這是個(gè)較高級別的斷開。 longName1 = longName2 * (longName3 + longName4 longName5) + 4 * longname6。 //PREFFER longName1 = longName2 * (longName3 + longName4 longName5) + 4 * longname6。 //AVOID 以下是兩個(gè)縮進(jìn)方法聲明的例子。前者是常規(guī)情形。后者若使用常規(guī)的縮進(jìn)方式將會(huì)使第二行和第三行移得很靠右，所以代之以縮進(jìn) 8 個(gè)空格 //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 個(gè)空格的規(guī)則，因?yàn)槌Ｒ?guī)縮進(jìn) (4 個(gè)空格)會(huì)使語句體看起來比較費(fèi)勁。比如： //不要使用如下縮進(jìn) if ((condition1 amp。amp。 condition2) || (condition3 amp。amp。 condition4) ||!(condition5 amp。amp。 condition6)) { //不好的換行 doSomethingAboutIt()。 //易使這行被忽視 } //使用如下縮進(jìn) if ((condition1 amp。amp。 condition2) || (condition3 amp。amp。 condition4) ||!(condition5 amp。amp。 condition6)) { doSomethingAboutIt()。 } JAVA 代碼規(guī)范 10 //或者使用如下縮進(jìn) if ((condition1 amp。amp。 condition2) || (condition3 amp。amp。 condition4) ||!(condition5 amp。amp。 condition6)) { doSomethingAboutIt()。 } 這里有三種可行的方法用于處理三元運(yùn)算表達(dá)式： alpha = (aLongBooleanExpression) ? beta : gamma。 alpha = (aLongBooleanExpression) ? beta : gamma。 alpha = (aLongBooleanExpression) ? beta : gamma?？招袑⑦壿嬒嚓P(guān)的代碼段分隔開，以提高可讀性。下列情況應(yīng)該總是使用兩個(gè)空行：? 一個(gè)源文件的兩個(gè)片段(section)之間? 類聲明和接口聲明之間 下列情況應(yīng)該總是使用一個(gè)空行：? 兩個(gè)方法之間? 方法內(nèi)的局部變量和方法的第一條語句之間? 塊注釋或單行注釋之前? 一個(gè)方法內(nèi)的兩個(gè)邏輯段之間，用以提高可讀性 下列情況應(yīng)該使用空格：? 一個(gè)緊跟著括號的關(guān)鍵字應(yīng)該被空格分開，例如： while (true) { ... } 注意：空格不應(yīng)該置于方法名與其左括號之間。這將有助于區(qū)分關(guān)鍵字和方法調(diào)用。? 空白應(yīng)該位于參數(shù)列表中逗號的后面? 所有的二元運(yùn)算符，除了.，應(yīng)該使用空格將之與操作數(shù)分開。一元操作符和操作數(shù)之間不因該加空格，比如：負(fù)號()、自增(++)和自減()。例如： a += c + d。a = (a + b) / (c * d)。 JAVA 代碼規(guī)范 11 while (d++ = s++) { n++。}printSize(size is + foo + \n)。 ? for 語句中的表達(dá)式應(yīng)該被空格分開，例如： for (expr1。 expr2。 expr3) ? 強(qiáng)制轉(zhuǎn)型后應(yīng)該跟一個(gè)空格，例如： myMethod((byte) aNum, (Object) x)。 myMethod((int) (cp + 5), ((int) (i + 3)) + 1)。Java 程序有兩類注釋：實(shí)現(xiàn)注釋(implementation ments)和文檔注釋(document ments)。實(shí)現(xiàn)注釋是那些在 C++中見過的，使用/*...*/和//界定的注釋。文檔注釋( 被稱為doc ments)是 Java 獨(dú)有的，并由/**...*/界定。文檔注釋可以通過 javadoc 工具轉(zhuǎn)換成 HTML 文件。注意：頻繁的注釋有時(shí)反映出代碼的低質(zhì)量。當(dāng)你覺得被迫要加注釋的時(shí)候，考慮一下重寫代碼使其更清晰。 注釋約定? 注釋應(yīng)該增加代碼的清晰度。代碼注釋的目的是要使代碼更易于被同時(shí)參與程序設(shè)計(jì)的開發(fā)人員以及其他后繼開發(fā)人員理解。? 避免使用裝飾性內(nèi)容，也就是說，不要使用象廣告橫幅那樣的注釋語句。典型的是用星號將他們的內(nèi)部注釋圈起來。這只是在大量浪費(fèi)時(shí)間，并不能給最終的產(chǎn)品增加絲毫價(jià)值。? 保持注釋的簡潔。最好的注釋應(yīng)該是簡單明了的注釋。注釋不必洋洋灑灑，只需提供足夠的信息，使別人能夠理解你的代碼。 ? 先寫注釋，后寫代碼。寫代碼注釋的最好方法是在寫代碼之前就寫注釋。這使你在寫代碼之前可以想想代碼的功能和運(yùn)行。而且這樣確保不會(huì)遺漏注釋。另一種方法是邊寫代碼邊寫注釋。因?yàn)樽⑨尶梢允勾a更易理解，所以在程序開發(fā)的過程中，也可以利用這一點(diǎn)。如果打算花些時(shí)間寫注釋，那么至少你應(yīng)從這個(gè)過程中獲得些什么 。 ? 注釋信息不僅要包括代碼的功能，還應(yīng)給出原因。例如，下面例子中的代碼顯示金額在 $1,000 以上（包括 $1,000）的定單可給予 5% 的折扣。為什么要這樣做呢？難道有一個(gè)商業(yè)法則規(guī)定大額定單可以得到折扣嗎？這種給大額定單的特殊是有時(shí)限的呢，還是一直都這樣？最初的程序設(shè)計(jì)者是否只是由于慷慨大度才這樣做呢？除非它們在某個(gè)地方（或者是在源代碼本身，或者是在一個(gè)外部文檔里）被注釋出來，否則你不可能知道這些。 JAVA 代碼規(guī)范 12 例：if (grandTotal