【正文】 Hidden” name=”ClientID”input type=”Text” name=”O(jiān)rd。 JAVA 代碼規(guī)范 22 Frame frameMain。static final int MAX_WIDTH = 999。char c。runFast()。 類(Classes)命名規(guī)則：類名是個一名詞，采用大小寫混合的方式，每個單詞的首字母大寫。? 項目名稱由該項目的負責(zé)人指定? 項目名稱用于以下場合：? 如命名 Visual Source Safe 項目名? 命名該項目在開發(fā)人員本地計算機的工作文件夾名? 命名 WSAD 文件名? 命名用于保存、拷貝、壓縮、電郵傳遞等場合的文件夾名或文件名一般情況下項目名不應(yīng)含版本信息，如遇特殊情況，由可考慮用數(shù)字和下劃線的方式來指定版本。 } catch (ExceptionClass e) { statements。 } 每當(dāng)一個 case 順著往下執(zhí)行時 (因為沒有 break 語句)，通常應(yīng)在 break 語句的位置添加注釋。 } while (condition)。 } 一個空的 for 語句(所有工作都在初始化，條件判斷，更新子句中完成）應(yīng)該具有如下格式： for (initialization。 } else { statements。? 大括號可以被用于所有語句，包括單個語句，只要這些語句是諸如ifelse 或 for 控制結(jié)構(gòu)的一部分。 } JAVA 代碼規(guī)范 16 int emptyMethod() {} ... } 簡單語句每行至多包含一條語句，例如： argv++。 ... myMethod() { if (condition) { int count = 0。）不要在首次用到該變量時才聲明之。亦即， int level。應(yīng)說明返回值的類型/類和可能的用途。標(biāo)記 用于 目的author name 類、 接口說明特定某一段程序代碼的作者。描述類和接口的文檔注釋的第一行(/**)不需縮進；隨后的文檔注釋每行都縮進 1 格(使星號縱向?qū)R) 。 /* special case */ } else { return isPrime(a)。在功能和方法內(nèi)部的塊注釋應(yīng)該和它們所描述的代碼具有一樣的縮進格式。 ? 注釋信息不僅要包括代碼的功能，還應(yīng)給出原因。注釋不必洋洋灑灑，只需提供足夠的信息，使別人能夠理解你的代碼。當(dāng)你覺得被迫要加注釋的時候，考慮一下重寫代碼使其更清晰。 expr2。這將有助于區(qū)分關(guān)鍵字和方法調(diào)用。 condition4) ||!(condition5 amp。amp。 condition2) || (condition3 amp。前者更好，因為斷開處位于括號表達式的外邊，這是個較高級別的斷開。4 個空格常被作為縮進排版的一個單位，以表示縮進，顯示程序的層次級別，增加程序的可讀性。 JAVA 代碼規(guī)范 8 ? 類和接口聲明下表描述了類和接口聲明的各個部分以及它們出現(xiàn)的先后次序。 2 通用代碼格式一個文件由被空行分割而成的段落以及標(biāo)識每個段落的可選注釋共同組成。除臨時性項目之外的任何項目均應(yīng)嚴格按照此標(biāo)準(zhǔn)執(zhí)行， “臨時性項目”指：? 為市場推廣目的而編寫的示程序? 為一次性用途而編寫的臨時性小程序為學(xué)習(xí)目的而編寫的測試程序? 文檔類別本文檔屬標(biāo)準(zhǔn)規(guī)范類的項目限制級文檔，未經(jīng)總經(jīng)理及總經(jīng)理授權(quán)人員批準(zhǔn)，不得提供公司以外的人員閱讀和使用。? 規(guī)范的執(zhí)行本文檔適用于公司內(nèi)進行軟件開發(fā)的所有技術(shù)人員，即公司內(nèi)軟件開發(fā)人員編寫的所有源代碼都必須遵循本規(guī)范。 ? 如果源代碼和軟件產(chǎn)品是捆綁給客戶的，作為產(chǎn)品的剩余部分，它應(yīng)該有好的分包（wellpackaged） ，足夠清晰和專業(yè)的代碼。 import 。其目的是為了更便于閱讀和理解代碼。 以下是兩個斷開算術(shù)表達式的例子。amp。 condition2) || (condition3 amp。amp。下列情況應(yīng)該總是使用兩個空行：? 一個源文件的兩個片段(section)之間? 類聲明和接口聲明之間 下列情況應(yīng)該總是使用一個空行：? 兩個方法之間? 方法內(nèi)的局部變量和方法的第一條語句之間? 塊注釋或單行注釋之前? 一個方法內(nèi)的兩個邏輯段之間，用以提高可讀性 下列情況應(yīng)該使用空格：? 一個緊跟著括號的關(guān)鍵字應(yīng)該被空格分開，例如： while (true) { ... } 注意：空格不應(yīng)該置于方法名與其左括號之間。 ? for 語句中的表達式應(yīng)該被空格分開，例如： for (expr1。注意：頻繁的注釋有時反映出代碼的低質(zhì)量。最好的注釋應(yīng)該是簡單明了的注釋。如果打算花些時間寫注釋，那么至少你應(yīng)從這個過程中獲得些什么 。它們也可以被用于其他地方，比如方法內(nèi)部。以下是一個 Java 代碼中尾端注釋的例子： if (a == 2) { return TRUE。該注釋應(yīng)位于聲明之前： /** * The Example class provides ... */ public class Example { ... 注意頂層(toplevel) 的類和接口是不縮進的，而其成員是縮進的。詳情請參考 J2SDK javadoc 文檔。return description 成員函數(shù) 若成員函數(shù)有返回值，對該返回值進行說明。 聲明 每行聲明變量的數(shù)量推薦一行一個聲明，因為這樣以利于寫注釋。（一個塊是指任何被包含在一對大括號{和 }中間的代碼。例如，不要在內(nèi)部代碼塊中聲明相同的變量名： int count。 ivar2 = j。? 左大括號{應(yīng)位于復(fù)合語句起始行的行尾；右大括號}應(yīng)另起一行并與復(fù)合語句首行對齊。 } if (condition) { statements。 update) { statements。 dowhile 語句一個 dowhile 語句應(yīng)該具有如下格式： do { statements。 break。 try { statements。此處主要討論后一種命名。這類命名規(guī)范可能以特定目錄名的組成來區(qū)分部門(department)，項目(project)，機器(machine)，或注冊名(login names)。run()。臨時變量通常被取名為 i，j，k，m 和 n，它們一般用于整型；c ，d，e，它們一般用于字符型。(盡量避免 ANSI 常量，容易引起錯誤)static final int MIN_WIDTH = 4。 String strUserName。 HTML 元素變量命名機制? form name：frmFormName? hidden，text：首字母大寫，不用下劃線。如：int nTemp ,IString strTempBoolean bTmp long lTem 全局變量、成員變量、局部變量命名規(guī)則? 局部變量：指在一個程序模塊中聲明使用的變量，該類變量使用 中定義的命名規(guī)則(以后稱一般命名)。如果有些對象不在以下表格中，請將該對象類名小寫做為前綴。實例變量(Instance Variables)大小寫規(guī)則和變量名相似，除了前面需要一個下劃線int _employeeId。變量名不應(yīng)以下劃線或美元符號開頭，盡管這在語法上是允許的。class ImageSprite。它們也可以提供一些有關(guān)標(biāo)識符功能的信息，以助于理解代碼，例如，不論它是一個常量，包，還是類。子語句提行書寫并縮 進一個四個空格。default 選項里的 break 是冗余的，但可預(yù)防以后增加另一個選項后沒有中斷執(zhí)行導(dǎo)致錯誤的情況出現(xiàn)。 break。 當(dāng)在 for 語句的初始化或更新子句中使用逗號時，避免因使用三個以上變量，而導(dǎo)致復(fù)雜度提高。 JAVA 代碼規(guī)范 17 } else{ statements。例如： return。 argc。? 右大括號}另起一行，與相應(yīng)的聲明語句對齊，除非是一個空語句，}應(yīng)緊跟在{之后 。 // 在方法的開始處 if (condition) { int int2 = 0。 不要將不同類型變量的聲明放在同一行，例如： int foo, fooarray[]。可以并且應(yīng)該采用完全合法的類名。exception name description 成員函數(shù) 說明由成員函數(shù)發(fā)出的異常。例如，有關(guān)一個類實現(xiàn)的細節(jié)，應(yīng)放入緊跟在類聲明后面的實現(xiàn)塊注釋中，而不是放在文檔注釋中。以下是所有三種風(fēng)格的例子： if (foo 1) { // Do a doubleflip. ... } else { return false。如果一個注釋不能在一行內(nèi)寫完，就該采用塊注釋(參見塊注釋)。 JAVA 代碼規(guī)范 12 例：if (grandTotal = ) {grandTotal = grandTotal * 。這使你在寫代碼之前可以想想代碼的功能和運行。? 避免使用裝飾性內(nèi)容，也就是說，不要使用象廣告橫幅那樣的注釋語句。Java 程序有兩類注釋：實現(xiàn)注釋(implementation ments)和文檔注釋(document ments)。例如： a += c + d。 } 這里有三種可行的方法用于處理三元運算表達式： alpha = (aLongBooleanExpression) ? beta : gamma。 condition6)) { doSomethingAboutIt()。amp。 //AVOID 以下是兩個縮進方法聲明的例子。注意：用于文檔中的例子應(yīng)該使用更短的行長，長度一般不超過 70 個字符。4 類的(靜態(tài)) 變量 首先是類的公共變量，隨后是保護變量，再后是包一級別的變量(沒有訪問修飾符，access modifier)，最后是私有變量。Package 行要在 Import 行之前， Import 中標(biāo)準(zhǔn)的包名要在本地的包名之前，而且按照字母順序排列。? 本文檔的使用者若對本文檔有任何評論、建議或意見，請通過企業(yè)內(nèi)部網(wǎng)絡(luò)發(fā)電子郵件給 SEPG，所收到的電子郵件將會在評審和修訂時給予充分的考慮。 JAVA 代碼規(guī)范 1 JAVA 代碼規(guī)范(初稿 ) JAVA 代碼規(guī)范 2 ?版本更新信息本版本創(chuàng)建/修改、維護、批準(zhǔn)涉及人員如下：創(chuàng)建/修改者：XX維護者：XX批準(zhǔn)者：XX具體版本更新記錄如表 11：表 11 版本更新記錄版本號 修改確認日期修改人 修改位置 修改方式（AMD）修改內(nèi)容概述 全部 A 初始版本發(fā)布修改方式：A－增加 M－修改 D－刪除