【正文】 賓語()示例：public String getType()。public void addNewOrder()。示例：OrderInformation, CustomerList, LogManager, LogConfig, SmpTransaction規(guī)則2 方法名使用類意義完整的英文描述：第一個(gè)單詞的字母使用小寫、剩余單詞首字母大寫其余字母小寫的大小寫混合法。 //1. 如果能被4整除，是閏年； //2. 如果能被100整除，不是閏年； //3. 如果能被400整除，是閏年。建議6 一些復(fù)雜的代碼需要說明。說明：調(diào)試程序的時(shí)候可以方便的使用 /* 。JavaDoc工具收集簡介的時(shí)候使用選取第一句話。接下來的部分可以詳細(xì)描述。中文注釋中需使用中文標(biāo)點(diǎn)。說明：這些語句往往是程序?qū)崿F(xiàn)某一特定功能的關(guān)鍵，對于維護(hù)人員來說，良好的注釋幫助更好的理解程序，有時(shí)甚至優(yōu)于看設(shè)計(jì)文檔。// 如果 receiveFlag 為真if (receiveFlag){ }而如下的注釋則給出了額外有用的信息。說明：注釋的目的是解釋代碼的目的、功能和采用的方法，提供代碼以外的信息，幫助讀者理解代碼，防止沒必要的重復(fù)注釋信息。說明：除非必要，不應(yīng)在代碼或表達(dá)中間插入注釋，否則容易使代碼可理解性變差。說明：在使用縮寫時(shí)或之前，應(yīng)對縮寫進(jìn)行必要的說明。說明：錯(cuò)誤的注釋不但無益反而有害。不再有用的注釋要刪除。說明：可使程序排版整齊，并方便注釋的閱讀與理解。異常的注釋必須說明該異常的含義及什么條件下拋出該異常。 對于非RuntimeException，即throws子句聲明會拋出的異常，必須在方法的注釋中標(biāo)明。 * 查詢時(shí)間為左包含原則，即 [startTime, endTime) 。 * 分配對應(yīng)日志類型的LogReader， 指定類型、查詢時(shí)間段、條件和反復(fù)器緩沖數(shù)， * 讀取日志記錄。格式：/** * 〈一句話功能簡述〉 * 〈功能詳細(xì)描述〉 * param [參數(shù)1] [參數(shù)1說明] * param [參數(shù)2] [參數(shù)2說明] * return [返回類型說明] * exception/throws [異常類型] [異常說明] * see [類、類方法、類成員]* since [起始版本] * deprecated */說明：since 表示從那個(gè)版本開始就有這個(gè)方法，如果是最初版本就存在的方法無需說明；exception或throws 列出可能仍出的異常；deprecated 表示不建議使用該方法。 * author 張三，李四，王五* see LogIteraotor * see BasicLog * since */public class LogManager規(guī)則3 類屬性(成員變量)、公有和保護(hù)方法注釋：寫在類屬性、公有和保護(hù)方法上面，注釋方式為“/** */”.示例：/** * 注釋內(nèi)容 */private String logType。 * 全部為靜態(tài)變量和靜態(tài)方法，對外提供統(tǒng)一接口。import .*。功能詳細(xì)描述部分說明該類或者接口的功能、作用、使用方法和注意事項(xiàng)，每次修改后增加作者和更新版本號和日期，since 表示從那個(gè)版本開始就有這個(gè)類或者接口，deprecated 表示不建議使用該類或者接口。類注釋使用“/** */”注釋方式說明：方便JavaDoc收集,沒有import可放在package之后。說明：由于每個(gè)文件的代碼注釋不一定都可以達(dá)到30%，建議以一個(gè)系統(tǒng)內(nèi)部模塊作為單位進(jìn)行檢查規(guī)則2 類和接口的注釋放在import 關(guān)鍵字之前。 示例： public static final String str = “abc”。 建議建議1 類屬性和類方法不要交叉放置，不同存取范圍的屬性或者方法也盡量不要交叉放置。說明：閱讀代碼更加清晰示例：if (a == b){ ()。}//此處是空行return。} 規(guī)則6 相對獨(dú)立的程序塊之間、變量說明之后必須加空行。 說明：閱讀代碼更加清晰，減少錯(cuò)誤產(chǎn)生 示例： if (ab){ doStart()。 Object b = null。 } 規(guī)則4 不允許把多個(gè)短語句寫在一行中，即一行只寫一條語句 說明：閱讀代碼更加清晰 示例：如下例子不符合規(guī)范。 }規(guī)則3 較長的語句、表達(dá)式或參數(shù)（80字符）要分成多行書寫，長表達(dá)式要在低優(yōu)先級操作符處劃分新行，操作符放在新行之首，劃分出的新行要進(jìn)行適當(dāng)?shù)目s進(jìn)，使排版整齊，語句可讀。在函數(shù)體的開始、類和接口的定義、以及if、for、do、while、switch、case語句中的程序或者static、synchronized等語句塊中都要采用如上的縮進(jìn)方式。說明：縮進(jìn)使程序更易閱讀，使用空格縮進(jìn)可以適應(yīng)不同操作系統(tǒng)與不同開發(fā)工具。 說明本規(guī)范分為規(guī)則和建議兩部分，規(guī)則為必須遵守，建議為參考。此規(guī)范并非最終文檔。. . . . .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 界面設(shè)計(jì)規(guī)范 19 規(guī)則 19 SQL編碼規(guī)范 20 SQL語句格式 20 SQL性能優(yōu)化 22 其他常見問題 30 條件回顯 30 父頁面刷新 31 用戶狀態(tài) 313 附錄 31 Eclipse 風(fēng)格 31 Eclipse 注釋模板 311 概述 編寫目的為了指導(dǎo)開發(fā)人員在項(xiàng)目的開發(fā)過程中能夠統(tǒng)一規(guī)范，統(tǒng)一風(fēng)格，提高代碼的可讀性和可維護(hù)行，提高軟件開發(fā)質(zhì)量，特編寫本開發(fā)規(guī)范。規(guī)范中有些內(nèi)容是強(qiáng)制遵守的，有些不一定要絕對遵守，但是一定要讓程序有良好的可讀性。 面向人員本開發(fā)規(guī)范適用于應(yīng)用軟件開發(fā)的所有開發(fā)人員、測試人員。2 Java編程規(guī)范 排版規(guī)范 規(guī)則規(guī)則1 程序塊要采用縮進(jìn)風(fēng)格編寫，縮進(jìn)的空格數(shù)為4個(gè)，不允許使用TAB縮進(jìn)。規(guī)則2 左分界符（‘{’）位于行尾，右分界符（‘}’）應(yīng)獨(dú)占一行，同時(shí)與引用它的語句左對齊。 示例: if (ab){ doStart()。示例： if (()){ (Session destroyed,callid + ().getCallId())。 Object o = new Object()。規(guī)則5 if, for, do, while, case, switch, default 等語句自占一行，且if, for, do, while,switch等語句的執(zhí)行語句無論多少都要加括號{},case 的執(zhí)行語句中如果定義變量必須加括號{}。} case x:{ int i = 9。 說明:閱讀代碼更加清晰示例：if(a b){ doStart()。規(guī)則7 在兩個(gè)以上的關(guān)鍵字、變量、常量進(jìn)行對等操作時(shí)，它們之間的操作符之前、之后或者前后要加空格；進(jìn)行非對等操作時(shí)，如果是關(guān)系密切的立即操作符（如.），后不應(yīng)加空格。}a *= 2。格式：類定義{ 類的公有屬性定義 類的保護(hù)屬性定義類的私有屬性定義 類的公有方法定義 類的保護(hù)方法定義 類的私有方法定義}建議2 修飾詞按照指定順序書寫：[訪問權(quán)限][static][final] 。 注釋規(guī)范 規(guī)則規(guī)則1 源程序注釋量必須在30％以上。注釋主要是一句話功能簡述與功能詳細(xì)描述。注釋可根據(jù)需要列出：作者、內(nèi)容、功能、與其它類的關(guān)系等。/** * 〈一句話功能簡述〉 * 〈功能詳細(xì)描述〉 * author [作者]（必須）* see [相關(guān)類/方法]（可選） * since [產(chǎn)品/模塊版本] （必須） * deprecated （可選） */示例：package 。/** * LogManager 類集中控制對日志讀寫的操作。分配對應(yīng)日志類型的讀寫器， * 讀取或?qū)懭敕蠗l件的日志紀(jì)錄。/** * 注釋內(nèi)容 */public void write()規(guī)則4 公有和保護(hù)方法注釋內(nèi)容：列出方法的一句話功能簡述、功能詳細(xì)描述、輸入?yún)?shù)、輸出參數(shù)、返回值、異常等。示例： /** * 根據(jù)日志類型和時(shí)間讀取日志。查詢條件為null或0的表示沒有限制，反復(fù)器緩沖數(shù)為0讀不到日志。 * param logTypeName 日志類型名（在配置文件中定義的） * param startTime 查詢?nèi)罩镜拈_始時(shí)間 * param endTime 查詢?nèi)罩镜慕Y(jié)束時(shí)間 * param logLevel 查詢?nèi)罩镜募墑e * param userName 查詢該用戶的日志 * param bufferNum 日志反復(fù)器緩沖記錄數(shù) * return 結(jié)果集，日志反復(fù)器 * since */ public static LogIterator read(String logType, Date startTime, Date endTime, int logLevel, String userName, int bufferNum)規(guī)則5 對于方法內(nèi)部用throw語句拋出的異常，必須在方法的注釋中標(biāo)明，對于所調(diào)用的其他方法所拋出的異常，選擇主要的在注釋中說明。說明：異常注釋用exception或throws表示，在JavaDoc中兩者等價(jià)，但推薦用exception標(biāo)注Runtime異常，throws標(biāo)注非Runtime異常。規(guī)則6 注釋應(yīng)與其描述的代碼相近，對代碼的注釋應(yīng)放在其上方，并與其上面的代碼用空行隔開，注釋與所描述內(nèi)容進(jìn)行同樣的縮排。示例： /* * 注釋*/public void example2( ){ // 注釋 CodeBlock One // 注釋 CodeBlock Two}/* * 注釋*/public void example( ){ //