java源代碼規范(編輯修改稿)

　

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