【正文】 明的情況下，可以不加注釋；普通成員方法要求說明完成什么功能，參數(shù)含義是什么且返回值什么；另外方法的創(chuàng)建時間必須注釋清楚，為將來的維護(hù)和閱讀提供寶貴線索；方法內(nèi)部注釋： 控制結(jié)構(gòu)，代碼做了些什么以及為什么這樣做，處理順序等，特別是復(fù)雜的邏輯處理部分，要盡可能的給出詳細(xì)的注釋；參數(shù)： 參數(shù)含義、及其它任何約束或前提條件；屬性： 字段描述；局部(中間)變量： 無特別意義的情況下不加注釋；注釋格式遵循工程規(guī)定的統(tǒng)一注釋格式，一般情況下會以 格式的文件導(dǎo)入 IDE(Eclipse)或者用Eclipse默認(rèn)的；四、代碼格式規(guī)范遵循工程規(guī)定的統(tǒng)一代碼格式，一般情況下直接使用 IDE(Eclipse)自帶的默認(rèn)代碼格式對代碼進(jìn)行格式化；五、其他規(guī)范JSP 文件命名采用完整的英文描述說明 JSP 所完成的功能，盡可能包括一個生動的動詞，第一個字母小寫，如： 、 等。public static Long USER_STATUS。如： public UserContext getLoginUser(String loginName)。參數(shù)量名不允許以下劃線或美元符號開頭，雖然這在語法上是允許的。方法名盡可能的描述出該方法的動作行為。在滿足 Classd 命名規(guī)則的基礎(chǔ)之上，保證開頭第一個字母為 ”E”，便于與普通的 Class區(qū)別開。在滿足 Classd 命名規(guī)則的基礎(chǔ)之上，保證開頭第一個字母為 ”I”，便于與普通的 Class區(qū)別開。盡量保證類名簡潔而富于描述。第四篇：JAVA程序員不可不注意的編碼規(guī)范最近經(jīng)?？匆恍┡笥褜懙脑创a，總是感覺編碼規(guī)范問題還沒有成為大家的關(guān)注點(diǎn)，導(dǎo)致代碼的通用可讀性相對比較差；所以在此嘮叨幾句編碼規(guī)范（以struts2+spring2+hibernate3架構(gòu)的項(xiàng)目為例），大家各取所需，歡迎拍磚！一、規(guī)范存在的意義應(yīng)用編碼規(guī)范對于軟件本身和軟件開發(fā)人員而言尤為重要，有以下幾個原因：好的編碼規(guī)范可以盡可能的減少一個軟件的維護(hù)成本 , 并且?guī)缀鯖]有任何一個軟件，在其整個生命周期中，均由最初的開發(fā)人員來維護(hù)；好的編碼規(guī)范可以改善軟件的可讀性，可以讓開發(fā)人員盡快而徹底地理解新的代碼；好的編碼規(guī)范可以最大限度的提高團(tuán)隊開發(fā)的合作效率；長期的規(guī)范性編碼還可以讓開發(fā)人員養(yǎng)成好的編碼習(xí)慣，甚至鍛煉出更加嚴(yán)謹(jǐn)?shù)乃季S；二、命名規(guī)范一般概念盡量使用完整的英文描述符采用適用于相關(guān)領(lǐng)域的術(shù)語采用大小寫混合使名字可讀盡量少用縮寫，但如果用了，必須符合整個工程中的統(tǒng)一定義避免使用長的名字（小于 15 個字母為正常選擇）避免使用類似的名字，或者僅僅是大小寫不同的名字避免使用下劃線（除靜態(tài)常量等）標(biāo)識符類型說明包（Package）的命名Package 的名字應(yīng)該采用完整的英文描述符，都是由一個小寫單詞組成。}。2)具名命名空間命名空間將除文件包含,全局標(biāo)識的聲明/定義以及類的前置聲明外的整個源文件封裝起來,以同其他命名空間相區(qū)分。像上文展示的那樣，不具名命名空間結(jié)束時用注釋//namespace標(biāo)識。bool AtEof(){return pos_ == EOF。在頭文件中使用不具名的空間容易違背C++的唯一定義原則。優(yōu)點(diǎn):。使用具名命名空間時,其名稱可基于項(xiàng)目或路徑名稱,不要使用using指示符。接口級別的約束經(jīng)常會被強(qiáng)類型所覆蓋public class Customer //錯誤public interface IList where T: Customer {} //正確public interface ICustomerList:IList {} 第二十八條 安全1． 總是對應(yīng)用程序私有的組件，集合等使用強(qiáng)名，這樣可以保證安全性2． 在應(yīng)用程序配置文件中使用加密算法，進(jìn)行安全保護(hù)3． 對不受控制的引用方法，要做適當(dāng)?shù)陌踩幚?，如加入斷言控?． 不要使用SuppressUnmanagedCodeSecurity屬性 5． 不要使用/。} } //正確class MyClass where T: SomeClass { void SomeMethod(T t){ SomeClass obj =t。class SomeClass {} //錯誤class MyClass { void SomeMethod(T t){ object temp=t。for(int count=1。安全性的優(yōu)先級永遠(yuǎn)高于性能。} }51． ()，不要依賴HandleCollector。}49．不要使用this引用，除非某些特殊情況，比如從一個構(gòu)造器中運(yùn)行另外一個//一個正確使用this的例子public class MyClass { public MyClass(string message){} public MyClass():this(”Hello){} }50． 不要使用base關(guān)鍵詞。default: (false)。case 2: (”Case 2:“)。switch(number){ case 1: (”Case 1:“)。//正確string name = 。if(obj2!= null){ ()。IMyInterface obj2。上限為12。} remove { m_SomeEvent= value。if(shepherd!= null){} 36． 37．{ 在使用一個委托前總是要先檢查它是否為空（null）不要提供公有成員變量，使用存取器（accessors）進(jìn)行替代public class MyPublisher MyDelegate m_SomeEvent。} }32． 33． 34． 35． 避免使用new,應(yīng)使用override替代在一個密封的類里總是把public和protected方法標(biāo)記為virtual 永遠(yuǎn)不要使用不安全的代碼 合理使用as操作符進(jìn)行映射Dog dog = new GermanShepherd()。} } } //正確class MyClass { public int Number { get。public int Number { get { return m_Number。for(int index=0。if(ok){}28．29． 總是使用從0開始的數(shù)組總是使用一個for循環(huán)顯式地初始化一個引用類型數(shù)組public class MyClass {} const int ArraySize=100。22． 避免對枚舉提供明確的值//正確public enum Color { Red,Green,Blue } //錯誤public enum Color { Red=1,Green=2,Blue=3 }23． 避免對枚舉指定類型//錯誤public enum Color : long { Red, Green, Blue }24． 25． 26． If語句總是使用括號，即使它只包含一句語句 避免使用?:條件運(yùn)算符 避免使用（if…endif），應(yīng)使用conditional方法代替[Conditianal(“MySpecialCondition”] public void MyMethod(){}27． 避免在布爾條件語句中調(diào)用函數(shù)，賦值到局部變量并檢查它們的值。}18． 定義自定義的異常時 19． 避免采用friend程序集，因?yàn)檫@樣增加了程序集間的耦合度 20． 避免使用依賴于從特定位置運(yùn)行的程序集的代碼。15． 16． 17． 每行代碼都應(yīng)該經(jīng)過白盒測試 僅捕獲已經(jīng)顯式處理了的異常在拋出異常的catch語句中，總是拋出最初異常以保持最初錯誤的堆棧位置catch(Exception exception){ ()。object GetObject(){} object someObject = GetObject()。} }14．對任何假設(shè)采用assert。public readonly int Number。第二十七條 編碼慣例1． 避免在一個文件中放多個類2． 一個文件應(yīng)該只對一個命名空間提供類型，避免在同一文件中有多個命名空間 3． 避免一個文件的長度超過500行（除了機(jī)器生成的代碼）4． 避免方法定義超過25行5． 避免超過5個參數(shù)的方法，使用結(jié)構(gòu)傳遞多個參數(shù) 6． 每行應(yīng)該不超過80個字符，或者10個單詞 7． 不要手工編輯任何機(jī)器生成的代碼，修改代碼格式和風(fēng)格以符合本編碼標(biāo)準(zhǔn) 8． 避免對顯而易見的內(nèi)容作注釋，由可讀性強(qiáng)的變量和方法組成的好的代碼應(yīng)該不需要注釋 9． 僅對操作的前提、內(nèi)在的算法等寫文檔 10． 避免方法級的文檔 11． 決不要硬編碼數(shù)值，聲明一個常量是最好的選擇 12． 僅對本輪就是常量的值使用const修飾符，例如一周的天數(shù) 13． 避免對只讀變量使用const修飾符。，數(shù)據(jù)庫連接等高危操作附近第二十六條 如有可能，盡量用算法調(diào)用代替手工編寫的循環(huán)對非常簡單的循環(huán)而言，手工編寫的循環(huán)有可能是最簡單也是最有效的解決方案。信息隱藏是優(yōu)秀軟件工程的關(guān)鍵，應(yīng)該將所有數(shù)據(jù)成員都設(shè)為私有的，這是類用來保持其不變式的最佳方式。第二十三條 要避免使用隱式轉(zhuǎn)換在做類型提供隱式轉(zhuǎn)換之前，請三思而行，應(yīng)該依賴的是顯式轉(zhuǎn)換。小類更有可能適用于各種不同情況。優(yōu)先調(diào)用前綴形式。請避免循環(huán)依賴。條件判斷的地方要避免使用連續(xù)嵌套的if 不要過分使用try 優(yōu)先使用標(biāo)準(zhǔn)算法不要根據(jù)類型標(biāo)簽（type tag）進(jìn)行分支（switch）第十八條 盡量減少定義性依賴，避免循環(huán)依賴循環(huán)依賴是指兩個模塊直接或者間接地相互依賴。：在可以使用amp。一些建議：盡量緊湊：對一個函數(shù)只賦予一種職責(zé)不要自我重復(fù)：優(yōu)先使用命名函數(shù)，而不要讓相似的代碼片斷反復(fù)出現(xiàn) 優(yōu)先使用amp。重要的特定于領(lǐng)域的常量應(yīng)該放在名字空間一級第十六條 盡可能局部的使用變量 第十七條 避免函數(shù)過長，避免嵌套過深過長的函數(shù)和嵌套過深的代碼塊的出現(xiàn)，經(jīng)常是因?yàn)闆]能賦予一個函數(shù)以一個緊湊的職責(zé)所致，這兩種情況通常都能夠通過更好的重構(gòu)予以解決?？梢杂梅柮Q和表達(dá)式替換它們，比如width*aspectRatio名稱能夠增加信息，并提供單一的維護(hù)點(diǎn)，而程序中到處重復(fù)的原始數(shù)據(jù)是無名的，維護(hù)起來很麻煩。第十五條 避免使用語義不清的參數(shù)。public const double productWeight = 。盡量不要強(qiáng)制轉(zhuǎn)換常量的類型。相比而言，編譯時檢查與控制流和數(shù)據(jù)無關(guān)，一般情況下能夠獲得更高的可信度。模塊和程序庫同樣應(yīng)該提供定義抽象和其中信息流的接口，從而使與調(diào)用代碼的通信比采用數(shù)據(jù)共享方式更安全，耦合度更低。絕對不要將類的數(shù)據(jù)成員設(shè)為public，僅對最需要的類型標(biāo)記為public，其他的標(biāo)記為internal。如果將注意力集中在概念而不是其表示形式上，就能夠提供富于提示性的接口，并按需要對實(shí)現(xiàn)進(jìn)行調(diào)整。而應(yīng)該公開抽象（至少是get/set抽象），而不是數(shù)據(jù)。建議用通信方式（比如消息隊列）代替數(shù)據(jù)共享。共享數(shù)據(jù)會增加耦合度，從而降低可維護(hù)性，通常還會降低性能。因此，默認(rèn)時，不要把注意力集中在如何使代碼更快上；首先關(guān)注的應(yīng)該是使代碼盡可能的清晰和易讀。竭盡全力避免使用指數(shù)算法。永遠(yuǎn)不要使用指數(shù)復(fù)雜性的算法，除非真的別無選擇在決定接受指數(shù)算法之前，必須盡力尋找替代方案，因?yàn)閷τ谥笖?shù)算法來說，即使是數(shù)據(jù)量的有限增加，也會使算法的性能急劇下降。）算法，就必須花費(fèi)精力尋找替代方案，只有代碼才不至于在數(shù)據(jù)量顯著增長的情況下陷入深度激增的性能深潭。了解算法的實(shí)際復(fù)雜性要留心那些不易發(fā)覺的陷阱，比如看似線性的算法實(shí)際上要調(diào)用其他線性操作，結(jié)果算法實(shí)際上是二次的。為了避免未來可能遭遇到的數(shù)據(jù)處理容量上的瓶頸問題，應(yīng)該預(yù)先做這些事情：使用靈活的、動態(tài)分配的數(shù)據(jù)，不要使用固定大小的數(shù)組那種“比現(xiàn)在所需要的最大數(shù)組還要大”的數(shù)組，在正確性和安全性方面都存在嚴(yán)重問題。不要使用不必要的操作符重載構(gòu)造函數(shù)的參數(shù)，應(yīng)該使用命名變量，而不要使用臨時變量這能夠避免可能的聲明二義性，還經(jīng)常能使代碼的意圖更加清晰，從而更容易維護(hù)，而且也更安全。要避免使用程序設(shè)計語言中的冷僻特性。用幾個簡單的行為來實(shí)現(xiàn)一個復(fù)雜的行為，比反其道而行之更加容易。應(yīng)該只選擇目的單一的函數(shù)，小而且目的單一的類，和邊界清晰的緊湊模塊。第五條 定期進(jìn)行代碼審查互相閱讀彼此