怎樣寫規(guī)范的代碼

?ZTEsecCorporation.Allrightsreserved怎樣寫規(guī)范的代碼CodingSpecification綜合業(yè)務(wù)產(chǎn)品線/秦亮2013年12月05日培訓(xùn)提綱代碼規(guī)定化的意義編碼規(guī)范指南怎樣寫規(guī)范的代碼代碼檢查工具介紹及使用代碼規(guī)范化的意義作為一個編碼人員，你一定維護過別人的代碼，你曾經(jīng)罵過“這真實一坨坨”，還是對其贊嘆尤佳呢，我當(dāng)然希望比人不要罵我的好。事實證明代碼總會被很多人去維護；一個軟件的生命周期中，80%的花費在于維護，規(guī)范的代碼可以減少編碼人員的理解時間，降低維護代價，易于進行二次開發(fā)；幾乎沒有任何一個軟件，在其整個生命同期中，均由最初的開發(fā)人員來維護，所以作為最初的你最好留下好的口碑；編碼規(guī)范可以改善軟件的可讀性，可以讓程序員盡快而徹底地理解新代碼；如果你將源碼作為產(chǎn)品發(fā)布，需要按照規(guī)范，確認(rèn)它是否被很好的打包并且清晰無誤；本文的目的不在于用條條框框來約束編碼人員，而在于用建議性的規(guī)范幫助編碼人員寫出易理解、易維護、易擴展的優(yōu)秀代碼。培訓(xùn)提綱代碼規(guī)定化的意義編碼規(guī)范指南怎樣寫規(guī)范的代碼代碼檢查工具介紹及使用編碼規(guī)范指南排版規(guī)范程序塊采用縮進，縮進空位為4個；分解符如“{”和“}”獨占一行，并且位于同列；較長的語句、表達式、參數(shù)要書寫多行；一行只寫一條語句；if,for,do,while,case,switch,default獨占一行，且語句塊都要加“{}”,無論語句多少相對獨立的業(yè)務(wù)語句塊之間，變量說明后加空行對齊只用空格不用TAB，避免不同編輯器對TAB處理不同對二個以上的關(guān)鍵字、變量、常量進行對等操作時，變量前后必須留空格，如果if(a==b)類屬性和方法不用交叉放置，不同存取范圍的屬性或方法也不遠(yuǎn)交叉放置編碼規(guī)范指南注釋規(guī)范有代碼的地方就有注釋，杜絕沒有任何注釋的代碼，推薦注釋量在20%以上；包的注釋：在包的當(dāng)前路徑放入一名為package.html的HTML文件，方面JavaDoc收集。注釋內(nèi)容簡述本包的作用、內(nèi)容、產(chǎn)品模塊、版本、版權(quán)等，如：文件注釋：文件開始，package關(guān)鍵字前面，記載版權(quán)說明、描述信息、生成日期、修改歷史；如：編碼規(guī)范指南4、類和接口的注釋：在package之后，class或interface之前，描述當(dāng)前類或接口的功能，作者，生成日期，修改日志，版本號等，如：5、類屬性、方法注釋：在類或方法的前面，類屬性記載屬性的功能用處，用/*開頭描述注釋，放置JavaDoc收集；類方法注釋需要記載方法的功能簡述、詳細(xì)、輸入?yún)?shù)、輸出值、拋出的異常、作者等，如：編碼規(guī)范指南6、類方法內(nèi)部注釋：注釋應(yīng)放置被注釋語句的正上方或右側(cè)；注釋必須與被注釋的語句同縮進；注釋與上面的代碼只有用一個空行隔開；屬于同一業(yè)務(wù)邏輯塊的代碼，須顯示注釋用途；對于變量定義和分支語句（if,switch,case）必須注釋；寫代碼的同時寫注釋，修改代碼的同時，也修改注釋；注釋塊內(nèi)部請不要加縮進；注釋內(nèi)容內(nèi)部需要著重提示的，請包括標(biāo)簽<b>xxxx</b>對于業(yè)務(wù)邏輯比較多的方法，建議顯示注釋步驟1、2,、3、4…注釋含義明確，不要寫無意義的注釋和難以理解的詞匯，如；編碼規(guī)范指南命名規(guī)范

上面說道了注釋規(guī)范，注釋的目的在于幫助編碼人員更好的理解代碼、維護代碼。當(dāng)然有些地方，如果命名非常規(guī)范，是可以不用注釋的，下面就說說又哪些命名規(guī)范；包的命名：常用命名方式：com.公司名.產(chǎn)品線名.項目名.模塊名，所有名稱全部小寫，如下圖：編碼規(guī)范的范疇2、類名和接口名的命名：盡量使用完整的英文描述，首字母大寫，每個英文單詞的首字母大寫，其余字母小寫。抽象類請以Abstract開頭，接口的實現(xiàn)類請以Impl接口，工具類請以Util或Utils結(jié)尾，如下列命名方式： StaffService、DefaultStaffService、AbstractEntity、StringUtils；3、方法命名；盡量使用完整的英文描述，首字母小寫，每個英文單詞的首字母大寫，其余字母小寫，屬性存取盡量使用setX、getX，返回布爾類型值的方法盡量使用isX，如下列命名方式： queryStaffById、isCodeExists()、getValue4、屬性命名；盡量使用完整的英文描述，首字母小寫，每個英文單詞的首字母大寫，其余字母小寫，屬性名和方法名不要重復(fù)；5、常量命名；使用全部大寫的英文描述，每個單詞之間用下劃線分隔，變量之前近可能使用final修飾，注意：枚舉也是一種常量；6、模塊內(nèi)部的組件，盡量以組件名開頭，如：StaffDAO、StaffService；7、組件命名，盡量以組件類型結(jié)果，如：StaffService、OrgService；8、準(zhǔn)確控制類成員方法的修飾符，如果僅限于類內(nèi)部使用用private修飾，可供子類或本包內(nèi)部使用用protected修飾，對所有公開，則用public；9、屬性和方法的命名不易過長，一般不超過15個字母；培訓(xùn)提綱代碼規(guī)定化的意義編碼規(guī)范指南怎樣寫規(guī)范的代碼代碼檢查工具介紹及使用怎樣寫規(guī)范的代碼

啰嗦了這么多，相信大家對編碼規(guī)范有一定的了解了，那么你的代碼規(guī)范嗎？你平時注意代碼規(guī)范嗎？怎樣寫規(guī)范的代碼，現(xiàn)在就談幾個注意事項：包結(jié)構(gòu)清晰，類、接口、方法、屬性命名貼切易懂；該注釋的地方注釋，注釋清楚、易懂，沒有二義性；做到上面2點，相信你的代碼已經(jīng)可以打60分以上了；接口定義明確，精確方法功能，每個方法只實現(xiàn)一個功能；方法內(nèi)部的代碼行數(shù)控制在200行以內(nèi)，一個類的代碼行數(shù)控制在1000行以內(nèi)，如果你的類代碼在1000行以上，請重新思考設(shè)計思路，這里說的代碼行數(shù)不把注釋計算在內(nèi)；多個方法內(nèi)部如果有相似的功能代碼塊，應(yīng)該提取為公用方法；盡量將業(yè)務(wù)相近的方法放在一起，便于尋找；方法內(nèi)部盡量不要catch異常，讓外部調(diào)用者知道出錯細(xì)節(jié)；方法內(nèi)部對于對象參數(shù)的調(diào)用，盡量判斷非null引用，除非你的設(shè)計能保證非空對象；不用的數(shù)據(jù)及時是否，如果數(shù)據(jù)庫連接、集合、共享鎖等；不要使用技巧性比較高的表達式；怎樣寫規(guī)范的代碼對于方法拋出的自定義異常，應(yīng)該寫明異常描述信息；評估你的數(shù)據(jù)，對變量采用合理的類型，如一個整數(shù)在1個字節(jié)8位以內(nèi)，應(yīng)該使用byte；該用基本數(shù)據(jù)類型就用基本數(shù)據(jù)類型，明確告訴虛擬機你的數(shù)據(jù)類型，避免虛擬機幫你做類型轉(zhuǎn)換，如：培訓(xùn)提綱代碼規(guī)定化的意義編碼規(guī)范指