【正文】 注釋 CodeBlock One // 注釋 CodeBlock Two}規(guī)則7 修改代碼同時(shí)修改相應(yīng)的注釋，以保證注釋與代碼的一致性。規(guī)則8 注釋的內(nèi)容要清楚、明了，含義準(zhǔn)確，防止注釋二義性。規(guī)則9 避免在注釋中使用縮寫，特別是不常用縮寫。 建議建議1 避免在一行代碼或表達(dá)式的中間插入注釋。建議2 在代碼的功能、意圖層次上進(jìn)行注釋，提供有用、額外的信息。示例：如下注釋意義不大。 // 如果從連結(jié)收到消息 if (receiveFlag){ }建議3 對(duì)關(guān)鍵變量的定義和分支語句（條件分支、循環(huán)語句等）必須編寫注釋。建議4 注釋應(yīng)考慮程序易讀及外觀排版的因素，使用的語言若是中、英兼有的，建議多使用中文，除非能用非常流利準(zhǔn)確的英文表達(dá)。方法和類描述的第一句話盡量使用簡潔明了的話概括一下功能，然后加以句號(hào)。說明：注釋語言不統(tǒng)一，影響程序易讀性和外觀排版，出于對(duì)維護(hù)人員的考慮，建議使用中文。建議5 方法內(nèi)的單行注釋使用 //。*/ 注釋掉一長段程序。示例：這里主要是對(duì)閏年算法的說明。 命名規(guī)范 規(guī)則規(guī)則1 類名和接口使用類意義完整的英文描述，每個(gè)英文單詞的首字母使用大寫、其余字母使用小寫的大小寫混合法。示例：private void calculateRate()。規(guī)則3 方法中，存取屬性的方法采用setter 和 getter方法，動(dòng)作方法采用動(dòng)詞和動(dòng)賓結(jié)構(gòu)。public boolean isFinished()。public void show()。規(guī)則4 屬性名使用意義完整的英文描述，第一個(gè)單詞的字母使用小寫，剩余單詞首字母大寫其余字母小寫的大小寫混合法。示例： private customerName。private smpSession。示例： public static final int MAX_VALUE = 1000。規(guī)則6 JSP文件命名采用第一個(gè)單詞的字母使用小寫、剩余單詞首字母大寫其余字母小寫的大小寫混合法；特殊JSP可以包括數(shù)字及下劃線；示例：主頁面：。（）動(dòng)作清單：中文說明英文說明編輯edit列表list新增add提示msg明細(xì)detail規(guī)則7 XML命名采用小寫字母風(fēng)格，不允許出現(xiàn)數(shù)字；文件格式：name使用camelCasing大小寫風(fēng)格，工程中命名唯一path使用camelCasing大小寫風(fēng)格，名稱和ClassName對(duì)應(yīng)，不顯示ClassName最后的Actionforward使用camelCasing大小寫風(fēng)格，不要使用下劃線字符 (‘_’)parameter=actionscope=request示例：，注意：其中XML配置中標(biāo)識(shí)bean對(duì)象的id命名，與其對(duì)應(yīng)的除首字母小寫外類名相同，必須保證id的唯一性。方法、變量名：當(dāng)由多個(gè)單詞組成時(shí)，采用camelCasing大小寫風(fēng)格。 建議建議1 包名采用域后綴倒置的加上自定義的包名，采用小寫字母，(不包括一些特殊原因)。部門內(nèi)部產(chǎn)品使用部門的名稱加上模塊名稱。說明：，如果因?yàn)镺EM合作等關(guān)系，可以不做要求。說明：清晰準(zhǔn)確的函數(shù)、變量等的命名，可增加代碼可讀性，并減少不必要的注釋。示例：Application 類型的，命名以App 結(jié)尾——MainAppFrame 類型的，命名以Frame 結(jié)尾——TopoFramePanel 類型的，建議命名以Panel 結(jié)尾——CreateCircuitPanelBean 類型的，建議命名以Bean 結(jié)尾——DataAccessBeanEJB 類型的，建議命名以EJB 結(jié)尾——DBProxyEJBApplet 類型的，建議命名以Applet 結(jié)尾——PictureShowApplet建議4 如果函數(shù)名超過15 個(gè)字母，可采用以去掉元音字母的方法或者以行業(yè)內(nèi)約定俗成的縮寫方式縮寫函數(shù)名。示例：customers, orderItems 編碼規(guī)范 規(guī)則規(guī)則1 數(shù)據(jù)庫操作、IO操作等需要使用結(jié)束close()的對(duì)象必須在try catchfinally 的finally中close()，如果有多個(gè)IO對(duì)象需要close()，需要分別對(duì)每個(gè)對(duì)象的close()方法進(jìn)行trycatch,防止一個(gè)IO對(duì)象關(guān)閉失敗其他IO對(duì)象都未關(guān)閉。}catch (IOException ioe){ //... ...}try{ ()。 說明：此規(guī)則指通常的系統(tǒng)非正常運(yùn)行產(chǎn)生的異常，不包括一些基于異常的設(shè)計(jì)。示例：try{ //.... ...}catch (IOException ioe){ (ioe)。說明：便于問題定位。規(guī)則4 運(yùn)行時(shí)異常使用RuntimeException的子類來表示，不用在可能拋出異常的方法聲明上加throws子句。說明：非運(yùn)行期異常是由外界運(yùn)行環(huán)境決定異常拋出條件的異常，例如文件操作，可能受權(quán)限、磁盤空間大小的影響而失敗，這種異常是程序本身無法避免的，需要調(diào)用者明確考慮該異常出現(xiàn)時(shí)該如何處理方法，因此非運(yùn)行期異常必須有throws子句標(biāo)出，不標(biāo)出或者調(diào)用者不捕獲該類型異常都會(huì)導(dǎo)致編譯失敗，從而防止程序員本身疏忽。拋出運(yùn)行期異常的目的是防止異常擴(kuò)散，導(dǎo)致定位困難。還有一種異常是Error 繼承而來的，這種異常由虛擬機(jī)自己維護(hù)，表示發(fā)生了致命錯(cuò)誤，程序無法繼續(xù)運(yùn)行例如內(nèi)存不足。規(guī)則5 在程序中使用異常處理還是使用錯(cuò)誤返回碼處理，根據(jù)是否有利于程序結(jié)構(gòu)來確定，并且異常和錯(cuò)誤碼不應(yīng)該混合使用，推薦使用異常。 但是不能用異常來做一般流程處理的方式，不要過多地使用異常，異常的處理效率比條件分支低，而且異常的跳轉(zhuǎn)流程難以預(yù)測。規(guī)則6 注意運(yùn)算符的優(yōu)先級(jí)，并用括號(hào)明確表達(dá)式的操作順序，避免使用默認(rèn)優(yōu)先級(jí)。示例：下列語句中的表達(dá)式word = (high 8) | low (1)if ((a | b) amp。 (a amp。 d)) (3)如果書寫為high 8 | lowa | b amp。 a amp。 d（1）（2）雖然不會(huì)出錯(cuò)，但語句不易理解；（3）造成了判斷條件出錯(cuò)。涉及物理狀態(tài)或者含有物理意義的常量，不應(yīng)直接使用數(shù)字，必須用有意義的靜態(tài)變量或者枚舉來代替。示例：如下的程序可讀性差。 ... // program code}應(yīng)改為如下形式：private final static int TRUNK_IDLE = 0。private final static int TRUNK_UNKNOWN = 1。 ... // program code}注意：Java 下建議使用枚舉來表示?！?。說明：使用int index[] 格式使程序的可讀性較差，int [] index 表示聲明了一個(gè)int數(shù)組(int [])叫做index示例：如下程序可讀性差：public int getIndex()[]{ ....}如下程序可讀性好：public int[] getIndex(){ ....}規(guī)則9 不要使用 與 進(jìn)行控制臺(tái)打印，應(yīng)該使用工具類(如：日志工具)進(jìn)行統(tǒng)一記錄或者打印。規(guī)則10 一個(gè)文件不要定義兩個(gè)類(并非指內(nèi)部類)。說明：沒必要寫的向上強(qiáng)制轉(zhuǎn)型會(huì)浪費(fèi)性能，增加代碼閱讀難度示例：以下錯(cuò)誤：FileInputStream fis = new FileInputStream(f)。 建議建議1 所有的數(shù)據(jù)類必須覆寫toString()、hashCode()、equals() 方法，toString()方法返回該類有意義的內(nèi)容。hashCode與equals可以使用eclipse自動(dòng)生成。 public String toString(){ return NodeName : + nodeName。說明：NullPointException拋出時(shí)常常描述為空，這樣往往看不出是出了什么錯(cuò)。 }建議3 一個(gè)方法不應(yīng)拋出太多類型的異常。如果確實(shí)有很多異常類型首先考慮用異常描述來區(qū)別，throws/exception子句標(biāo)明的異常最好不要超過三個(gè)。說明：可以設(shè)計(jì)更合理異常處理分支建議5 如果多段代碼重復(fù)做同一件事情，那么在方法的劃分上可能存在問題。建議6 集合中的數(shù)據(jù)如果不使用了應(yīng)該及時(shí)釋放，尤其是可重復(fù)使用的集合。建議7 源程序中關(guān)系較為緊密的代碼應(yīng)盡可能相鄰。示例：矩形的長與寬關(guān)系較密切，放在一起。 = 5。說明：高技巧語句不等于高效率的程序，實(shí)際上程序的效率關(guān)鍵在于設(shè)計(jì)與算法。一個(gè)函數(shù)僅完成一件功能，即使簡單功能也編寫方法實(shí)現(xiàn)。建議10 應(yīng)明確規(guī)定對(duì)接口方法參數(shù)的合法性檢查應(yīng)由方法的調(diào)用者負(fù)責(zé)還是由接口方法本身負(fù)責(zé)，缺省是由方法調(diào)用者負(fù)責(zé)。建議11 盡量使用Java 。...for(String str:list){ } 建議12 使用Java 。if (t == ){ 。 }建議13 interface 中定義的常量不要寫public、static、final的修飾詞，方法不要寫public修飾詞。 void doStart()。說明：性能測試時(shí)可對(duì)線程狀態(tài)進(jìn)行監(jiān)控，異常時(shí)也可以知道異常發(fā)生在哪個(gè)線程中 性能與可靠性 規(guī)則規(guī)則1 對(duì)邏輯類型的變量使用Boolean類型來聲明，如果使用int類型來聲明，默認(rèn)0表示False,非0表示True，不應(yīng)該出現(xiàn)使用0代表真、成功等含義。說明：日志一般都會(huì)有不少字符串的處理，如果不是Debug級(jí)別就沒有必要進(jìn)行處理示例：if (()){ (“request : ” + ())。說明：更好的性能規(guī)則4 不要使用循環(huán)將集合轉(zhuǎn)為數(shù)組，可以使用集合的toArray()方法。 .... String [] array = new String[()]。規(guī)則5 大量字符串的相加等處理應(yīng)該使用StringBuffer。“大量”一般指5次“+=”以上或者在循環(huán)中進(jìn)行字符串+=操作。str += ”a”。推薦：StringBuffer sb = new StringBuffer()。(“bb”)。規(guī)則6 對(duì)類中日志工具對(duì)象logger應(yīng)聲明為static. 說明：防止重復(fù)new 出logger對(duì)象(logger指各種日志工具類，可以是log4j，mon log，jdk logger，內(nèi)部API等，盡管一些logger對(duì)LogFactory工廠有一些優(yōu)化，但是我們也必須防止代碼沒有必要的運(yùn)行)。說明：底層函數(shù)必須保證輸入?yún)?shù)正確性再進(jìn)行其他處理(防止后面的代碼拋出錯(cuò)誤，減少?zèng)]有必要的后續(xù)代碼運(yùn)行)。示例：pu