【正文】 ......................................................................27 存取函數(shù)的可見性 ....................................................................................................27 一定要初始化靜態(tài)字段 ............................................................................................276 成員函數(shù)和方法標(biāo)準(zhǔn) ................................................................................................................28 命名函數(shù)和成員方法 ........................................................................................................28 命名存取成員函數(shù)和方法 ................................................................................................28 命名構(gòu)造函數(shù) ....................................................................................................................29 成員函數(shù)和方法的可見性 ................................................................................................29 成員函數(shù)和方法參數(shù)標(biāo)準(zhǔn) ................................................................................................30 命名參數(shù) ....................................................................................................................30 注釋參數(shù) ....................................................................................................................30 注釋成員函數(shù)和方法 ........................................................................................................307 編程慣例 ....................................................................................................................................32 提供對(duì)實(shí)例以及類變量的訪問控制 ................................................................................32 引用類變量和類方法 ........................................................................................................32 常量 ....................................................................................................................................32 變量賦值 ............................................................................................................................328 其它慣例 ....................................................................................................................................33 圓括號(hào) ................................................................................................................................33 返回值 ................................................................................................................................33 條件運(yùn)算符?前的表達(dá)式 ...............................................................................................33 JAVA 代碼規(guī)范 6 特殊注釋 ............................................................................................................................349 代碼范例 ....................................................................................................................................34 源文件范例 ........................................................................................................................3410 縮寫說明 ................................................................................................................................3511 參考資料 ................................................................................................................................36 JAVA 代碼規(guī)范 7 1 介紹 為什么要有編碼規(guī)范編碼規(guī)范對(duì)于程序員而言尤為重要，有以下幾個(gè)原因：? 一個(gè)軟件產(chǎn)品的 80%的生命期是在維護(hù)。 2 通用代碼格式一個(gè)文件由被空行分割而成的段落以及標(biāo)識(shí)每個(gè)段落的可選注釋共同組成。例如： package 。 JAVA 代碼規(guī)范 8 ? 類和接口聲明下表描述了類和接口聲明的各個(gè)部分以及它們出現(xiàn)的先后次序。5 實(shí)例變量 首先是公共級(jí)別的，隨后是保護(hù)級(jí)別的，再后是包一級(jí)別的(沒有訪問修飾符)，最后是私有級(jí)別的。4 個(gè)空格常被作為縮進(jìn)排版的一個(gè)單位，以表示縮進(jìn)，顯示程序的層次級(jí)別，增加程序的可讀性。當(dāng)一個(gè)表達(dá)式無法容納在一行內(nèi)時(shí)，可以依據(jù)如下一般規(guī)則斷開之：? 在一個(gè)逗號(hào)后面斷開? 在一個(gè)操作符前面斷開? 寧可選擇較高級(jí)別(higherlevel)的斷開，而非較低級(jí)別(lowerlevel)的斷開? 新的一行應(yīng)該與上一行同一級(jí)別表達(dá)式的開頭處對(duì)齊? 如果以上規(guī)則導(dǎo)致你的代碼混亂或者使你的代碼都堆擠在右邊，那就代之以縮進(jìn) 8 個(gè)空格。前者更好，因?yàn)閿嚅_處位于括號(hào)表達(dá)式的外邊，這是個(gè)較高級(jí)別的斷開。前者是常規(guī)情形。 condition2) || (condition3 amp。 condition6)) { //不好的換行 doSomethingAboutIt()。amp。 } JAVA 代碼規(guī)范 10 //或者使用如下縮進(jìn) if ((condition1 amp。 condition4) ||!(condition5 amp。 alpha = (aLongBooleanExpression) ? beta : gamma。這將有助于區(qū)分關(guān)鍵字和方法調(diào)用。a = (a + b) / (c * d)。 expr2。實(shí)現(xiàn)注釋是那些在 C++中見過的，使用/*...*/和//界定的注釋。當(dāng)你覺得被迫要加注釋的時(shí)候，考慮一下重寫代碼使其更清晰。典型的是用星號(hào)將他們的內(nèi)部注釋圈起來。注釋不必洋洋灑灑，只需提供足夠的信息，使別人能夠理解你的代碼。而且這樣確保不會(huì)遺漏注釋。 ? 注釋信息不僅要包括代碼的功能，還應(yīng)給出原因。} 實(shí)現(xiàn)注釋的格式程序可以有 4 種實(shí)現(xiàn)注釋的風(fēng)格：塊(block) 、單行 (singleline)、尾端(trailing)和行末(endofline) 。在功能和方法內(nèi)部的塊注釋應(yīng)該和它們所描述的代碼具有一樣的縮進(jìn)格式。單行注釋之前應(yīng)該有一個(gè)空行。 /* special case */ } else { return isPrime(a)。 // Explain why here. } //if (bar 1) { // // // Do a tripleflip. // ... //} //else { // return false。描述類和接口的文檔注釋的第一行(/**)不需縮進(jìn)；隨后的文檔注釋每行都縮進(jìn) 1 格(使星號(hào)縱向?qū)R) 。文檔注釋不能放在一個(gè)方法或構(gòu)造器的定義塊中，因?yàn)?Java 會(huì)將位于文檔注釋之后的第一個(gè)聲明與其相關(guān)聯(lián)。標(biāo)記 用于 目的author name 類、 接口說明特定某一段程序代碼的作者。一個(gè)異常采用一個(gè)標(biāo)記，并要給出異常的完整類名。應(yīng)說明返回值的類型/類和可能的用途。see ClassNamemember functionName類、接口、成員函數(shù)、字段在文檔中生成指向特定成員函數(shù)的超文本鏈接。亦即， int level。 //避免！ 注意：上面的例子中，在類型和標(biāo)識(shí)符之間放了一個(gè)空格 初始化在聲明局部變量的同時(shí)初始化。）不要在首次用到該變量時(shí)才聲明之。 //在”if ”塊的開始處 ... } } 該規(guī)則的一個(gè)例外是 for 循環(huán)的索引變量 for (int i = 0。 ... myMethod() { if (condition) { int count = 0。 class Sample extends Object { int ivar1。 } JAVA 代碼規(guī)范 16 int emptyMethod() {} ... } 簡(jiǎn)單語(yǔ)句每行至多包含一條語(yǔ)句，例如： argv++。 // 避免！