程序編碼規(guī)范java(存儲版)
【正文】 變量的命名 4 接口的命名 5 參數(shù)的命名 5 數(shù)組的命名 5 方法的參數(shù) 6三 注釋規(guī)范 6 塊注釋(Block Comments) 7 單行注釋(SingleLine Comments) 7 尾端注釋(Trailing Comments) 7 行末注釋(EndOfLine Comments) 8四 Java 文件樣式 8 版權(quán)信息 8 Package/Imports 9 Class 9 Class Fields 10 存取方法 10 構(gòu)造函數(shù) 10 main 方法 11 換行(Wrapping Lines) 11 行長度(Line Length) 13 語句(Statements) 13五 排版格式 18六 JSP 編碼規(guī)范 19七、文件與目錄 20八、日志規(guī)范 20九、設(shè)計及技巧建議 21 22 22 22 一、引言編碼規(guī)范對于程序員而言尤為重要，有以下幾個原因： 一個軟件的生命周期中，80%的花費在于維護。二、命名規(guī)范 包（Package）的命名 包(Packages)： 一個唯一包名的前綴應(yīng)全部為小寫的ASCII字母，并且是一個頂級域名，通常為、edu、gov、mil、net、org等。char c （c、d、e常用于表示字符型）int I （i、j、k、m、n 常用于表示整型）float myWidth。除了以下幾個特例之外，命名時應(yīng)始終采用完整的英文描述符。 方法的參數(shù) 使用有意義的參數(shù)來命名，名字盡量和將要賦值的字段一致。它可以使手頭沒有源碼的開發(fā)人員讀懂程序。塊注釋之首應(yīng)該有一個空行，用于把塊注釋和代碼分割開來，比如：/** 在這里寫塊注釋*/ 單行注釋(SingleLine Comments)單行注釋之前也應(yīng)該有一個空行。它一般不用于連續(xù)多行的注釋文本中，常用來注釋掉連續(xù)多行的代碼段。import .*。}public int[] getPackets(String s) { return copyArray(packets, offset)。var = someMethod1(longExpression1,someMethod2(longExpression2,longExpression3))。比如：//DON’T USE THIS INDENTATIONif ((condition1 amp。amp。 condition2) || (condition3 amp。 行長度(Line Length)盡量避免一行的長度超過80個字符，因為很多終端和工具不能很好處理之。這樣便于添加語句而無需擔(dān)心由于忘了加括號而引入bug。}if (condition) {statements。 condition。switch語句(switch Statements)一個switch語句應(yīng)該具有如下格式：switch (condition) {case ABC:statements。上面的示例代碼中就包含注釋/* falls through */。2. 相對獨立的程序塊與塊之間加空行。10. 用大括號‘{’和‘}’界定一段程序塊的，編寫程序塊時‘{’和 ‘}’應(yīng)各獨占一行并且位于同一列，同時與引用它們的語句左對齊。如：jsp控制器 被包含的: jsp jsp會話bena: xxxxSessionBean標(biāo)記類 : xxxxTag,xxxxTagExtraInfo7. 應(yīng)當(dāng)避免設(shè)計既顯示表單又處理結(jié)果的頁面。14. jsp bean中不應(yīng)當(dāng)包含大量的數(shù)據(jù)。獲取和放棄資源是jsp beans和標(biāo)記處理器的事，而不是由jsp來負責(zé)的。九、設(shè)計及技巧建議系統(tǒng)主要的層次是表現(xiàn)層、業(yè)務(wù)層和持久層，整體應(yīng)采用taglib+struts+spring+hibernate架構(gòu)，各層：表現(xiàn)層主要是用taglib來實現(xiàn)的，數(shù)據(jù)來源是業(yè)務(wù)層，不要直接使用持久層獲取數(shù)據(jù)，查詢數(shù)據(jù)需要組裝查詢VO(***QueryVO),每個模塊內(nèi)的包分別是：actions，按功能分別存放Actionforms, 存放各個功能分別用到的formbeanmodels 存放各種類型的list所用到的DataModel業(yè)務(wù)層為表現(xiàn)層提供接口（用統(tǒng)一的工廠來管理這些接口），并且對常用數(shù)據(jù)做緩存。5. 產(chǎn)品自定義的struts配置文件的命名應(yīng)該以“strutsconfig”+產(chǎn)品的名稱+某塊名稱+“.xml”，6. Spirng的配置文件必須放在WEBINF/目錄下。20. 每個jsp文件中都應(yīng)當(dāng)使用一個錯誤頁面來處理不能夠從中恢復(fù)的異常。13. 除了jsp bean之外，jsp不應(yīng)當(dāng)去實例化復(fù)雜的可讀寫的對象。5. 盡量把條件邏輯放在控制器中而不是放在視圖中。 8. 不允許把多個短語句寫在一行中，即一行只寫一條語句。} finally {statements。break。l dowhile語句(dowhile Statements)一個dowhile語句應(yīng)該具有如下格式：do {statements。 update) {statements。}if (condition) {statements。 // AVOID!l 復(fù)合語句(Compound Statem
公司管理相關(guān)推薦
鄂ICP備17016276號-1