【正文】 列出方法的一句話功能簡述、功能詳細描述、輸入?yún)?shù)、輸出參數(shù)、返回值、異常等。/** * LogManager 類集中控制對日志讀寫的操作。注釋可根據(jù)需要列出：作者、內(nèi)容、功能、與其它類的關系等。 注釋規(guī)范 規(guī)則規(guī)則1 源程序注釋量必須在30％以上。}a *= 2。 說明:閱讀代碼更加清晰示例：if(a b){ doStart()。規(guī)則5 if, for, do, while, case, switch, default 等語句自占一行，且if, for, do, while,switch等語句的執(zhí)行語句無論多少都要加括號{},case 的執(zhí)行語句中如果定義變量必須加括號{}。示例： if (()){ (Session destroyed,callid + ().getCallId())。規(guī)則2 左分界符（‘{’）位于行尾，右分界符（‘}’）應獨占一行，同時與引用它的語句左對齊。 面向人員本開發(fā)規(guī)范適用于應用軟件開發(fā)的所有開發(fā)人員、測試人員。. . . . .Java 編程規(guī)范目 錄1 概述 3 編寫目的 3 面向人員 3 說明 32 Java編程規(guī)范 3 排版規(guī)范 3 規(guī)則 3 建議 4 注釋規(guī)范 5 規(guī)則 5 建議 8 命名規(guī)范 9 規(guī)則 9 建議 11 編碼規(guī)范 12 規(guī)則 12 建議 15 性能與可靠性 17 規(guī)則 17 建議 19 界面設計規(guī)范 19 規(guī)則 19 SQL編碼規(guī)范 20 SQL語句格式 20 SQL性能優(yōu)化 22 其他常見問題 30 條件回顯 30 父頁面刷新 31 用戶狀態(tài) 313 附錄 31 Eclipse 風格 31 Eclipse 注釋模板 311 概述 編寫目的為了指導開發(fā)人員在項目的開發(fā)過程中能夠統(tǒng)一規(guī)范，統(tǒng)一風格，提高代碼的可讀性和可維護行，提高軟件開發(fā)質(zhì)量，特編寫本開發(fā)規(guī)范。 說明本規(guī)范分為規(guī)則和建議兩部分，規(guī)則為必須遵守，建議為參考。在函數(shù)體的開始、類和接口的定義、以及if、for、do、while、switch、case語句中的程序或者static、synchronized等語句塊中都要采用如上的縮進方式。 } 規(guī)則4 不允許把多個短語句寫在一行中，即一行只寫一條語句 說明：閱讀代碼更加清晰 示例：如下例子不符合規(guī)范。 說明：閱讀代碼更加清晰，減少錯誤產(chǎn)生 示例： if (ab){ doStart()。}//此處是空行return。 建議建議1 類屬性和類方法不要交叉放置，不同存取范圍的屬性或者方法也盡量不要交叉放置。說明：由于每個文件的代碼注釋不一定都可以達到30%，建議以一個系統(tǒng)內(nèi)部模塊作為單位進行檢查規(guī)則2 類和接口的注釋放在import 關鍵字之前。功能詳細描述部分說明該類或者接口的功能、作用、使用方法和注意事項，每次修改后增加作者和更新版本號和日期，since 表示從那個版本開始就有這個類或者接口，deprecated 表示不建議使用該類或者接口。 * 全部為靜態(tài)變量和靜態(tài)方法，對外提供統(tǒng)一接口。格式：/** * 〈一句話功能簡述〉 * 〈功能詳細描述〉 * param [參數(shù)1] [參數(shù)1說明] * param [參數(shù)2] [參數(shù)2說明] * return [返回類型說明] * exception/throws [異常類型] [異常說明] * see [類、類方法、類成員]* since [起始版本] * deprecated */說明：since 表示從那個版本開始就有這個方法，如果是最初版本就存在的方法無需說明；exception或throws 列出可能仍出的異常；deprecated 表示不建議使用該方法。 * 查詢時間為左包含原則，即 [startTime, endTime) 。異常的注釋必須說明該異常的含義及什么條件下拋出該異常。不再有用的注釋要刪除。說明：在使用縮寫時或之前，應對縮寫進行必要的說明。說明：注釋的目的是解釋代碼的目的、功能和采用的方法，提供代碼以外的信息，幫助讀者理解代碼，防止沒必要的重復注釋信息。說明：這些語句往往是程序?qū)崿F(xiàn)某一特定功能的關鍵，對于維護人員來說，良好的注釋幫助更好的理解程序，有時甚至優(yōu)于看設計文檔。接下來的部分可以詳細描述。說明：調(diào)試程序的時候可以方便的使用 /* 。 //1. 如果能被4整除，是閏年； //2. 如果能被100整除，不是閏年； //3. 如果能被400整除，是閏年。public void addNewOrder()。public void setVisible(boolean)。屬性名不能與方法名相同。規(guī)則5 常量名使用全大寫的英文描述，英文單詞之間用下劃線分隔開，并且使用 static final修飾。(功能英文名由詳細設計文檔提供)子頁面(可編輯、iframe等)：功能英文名＋。示例：文件：； 插入一行方法：insertRow()。產(chǎn)品線的產(chǎn)品使用產(chǎn)品的名稱加上模塊的名稱。建議3 常用組件類的命名以組件名加上組件類型名結(jié)尾。}private void calculateRate(){ 。示例：try{ // ... ...}catch(IOException ioe){ //... ...}finally{ try{ ()。若有特殊原因必須用注釋加以說明。示例：throw new IOException(Writing data error! Data: + ())。運行期異常是程序在運行過程中本身考慮不周導致的異常，例如傳入錯誤的參數(shù)等。我們自己的程序不應該捕獲這種異常，并且也不應該創(chuàng)建該種類型的異常。注意：Java 程序內(nèi)部的錯誤碼可以使用枚舉來表示。amp。amp。規(guī)則7 避免使用不易理解的數(shù)字，用有意義的標識來替代。if (state == 0){ state = 1。if (state == TRUNK_IDLE){ state = TRUNK_BUSY。} 規(guī)則8 數(shù)組聲明的時候使用 int[] index ，而不要使用 int index[] 。說明：方便程序的閱讀與代碼的維護 規(guī)則11 判斷語句不要使用”* == true”來判斷為真說明：方便閱讀，減少沒有必要的計算以下錯誤：if (ok == true){ ……}以下正確：if (ok){ ……}規(guī)則12 不要寫沒有必要的向上強制轉(zhuǎn)型。說明：方便數(shù)據(jù)類的比較，父類如果實現(xiàn)了比較合理的toString() ，子類可以繼承不必再重寫。 }} 建議2 ()，()，一般可通過日志工具記錄完整的異常堆棧信息。說明： 如果程序中需要分類處理，則將異常根據(jù)分類組織成繼承關系。說明：若此段代碼各語句之間有實質(zhì)性關聯(lián)并且是完成同一件功能的，那么可考慮把此段代碼構(gòu)造成一個新的方法。說明：便于程序閱讀和查找。建議8 不要使用難懂的技巧性很高的語句，除非很有必要時。 說明：雖然為僅用一兩行就可完成的功能去編方法好象沒有必要，但用方法可使功能明確化，增加程序可讀性，亦可方便維護、測試。(+)說明：代碼更加簡潔示例：ArrayListString list = new ArrayListString()。說明：更加簡潔示例：public interface InterfaceT{ String TT = abcl。規(guī)則2 對Debug，Info級別日志輸出前必須對當前的調(diào)試等級先進行判斷。說明：更好的性能，代碼更加簡潔示例：ArrayList list = new ArrayList()。說明：大量的String相加等于處理性能消耗較多。str += ”b”。(“cc”)。使用RuntimeException 減少了try catch滿天飛，并有利于快速定于異常代碼。示例： FileOutputStream file= new FileOutputStream()。 i++ ){ (…)。確定、確認，原則上采用確定。示例： 規(guī)則3 GridGRID中盡量不出現(xiàn)橫向滾動條，grid中顯示主要內(nèi)容，grid下方顯示次要信息。 SQL編碼規(guī)范 SQL語句格式規(guī)則1 JAVA程序中使用SQL語句時，所有SQL關鍵字、實體全部使用大寫字母。所有SQL拼接全部寫在DAO層規(guī)則2 存儲過程語句中出現(xiàn)的所有表名、字段名全部小寫，系統(tǒng)保留字、內(nèi)置函數(shù)名、SQL保留字大寫； 連接符OR、IN、AND以及＝等前后加上一個空格；對較為復雜的SQL語句加上注釋，說明及算法功能等。 PROCEDURE MY_PROCEDURE( 參數(shù)1 IN VARCHAR2, 參數(shù)1 IN VARCHAR2, 參數(shù)1 IN VARCHAR2, ......, 參數(shù)n OUT INTEGER RESULT_NAME OUT VARCHAR2)。 V_CON_2 NUMBER(2)。 實現(xiàn)代碼 SQL Code EXCEPTION WHEN OTHERS THEN v_error_code := SQLCODE。END MY_PROCEDURE。 示例：　　 (低效,)　SELECT * 　　 FROM EMP E 　　 WHERE SAL 50000 　　 AND JOB = 39。MANAGER39。實際上，Oracle在解析的過程中，會將39。 示例：以下有三種方法可以檢索出雇員號等于0342或0291的職員　　 　　方法1 (最低效)SELECT EMP_NAME, SALARY, GRADE 　　 FROM EMP 　　 WHERE EMP_NO = 342?！　?FETCH C1 INTO …,…,…?！　?END。002039。003039。002039。003039。002039。X39。 示例：低效SELECT REGION, AVG(LOG_SIZ