資源描述:
《JAVA 編程規(guī)范》由會員上傳分享,免費(fèi)在線閱讀,更多相關(guān)內(nèi)容在教育資源-天天文庫。
1、廣州普翔軟件科技有限公司JAVA編程規(guī)范擬制人:杜政飛擬制時間:2006-8-30廣州普翔軟件科技有限公司第24頁共27頁廣州普翔軟件科技有限公司版本變更記錄:版本號擬制日期擬制人版本描述存檔編號12006-08杜政飛初次制定第24頁共27頁廣州普翔軟件科技有限公司目錄前言11范圍12使用工具13代碼規(guī)范13.1源文件規(guī)范13.1.1原文件后綴13.1.2常用類名約定13.1.3文件組織23.1.4編碼格式43.2優(yōu)化規(guī)范183.2.1容器類使用183.2.2synchronized183.2.3
2、向變量賦null193.2.4ArrayCopy193.2.5finalize方法的使用193.2.6字符串連接193.2.7通信操作關(guān)閉193.2.8Private方法使用193.2.9使用log4j打印輸出193.2.10避免使用已經(jīng)被棄用的方法203.2.11Java.util.Calendar和java.util.Date設(shè)計很差勁203.2.12用反射實(shí)例化內(nèi)部類需要一個額外的參數(shù)203.2.13從字節(jié)數(shù)組到字符數(shù)組的轉(zhuǎn)換需要指定字符集203.2.14String.replaceAll以
3、正則表達(dá)式作為第一個參數(shù),以置換字符串作為第二個參數(shù)203.2.15Char類型值只會默認(rèn)轉(zhuǎn)換成int,而不是String203.2.16不要嘗試類自動初始化,很可能造成線程死鎖204第三方控件的使用22第24頁共27頁廣州普翔軟件科技有限公司前言為了統(tǒng)一后臺代碼的風(fēng)格和提高后臺代碼的開發(fā)質(zhì)量,制定本規(guī)范,所有的后臺代碼都按照該規(guī)范執(zhí)行。1范圍本規(guī)范適用于中興軟創(chuàng)開發(fā)二部的后臺JAVA的設(shè)計開發(fā)。2使用工具后臺Java類開發(fā)的IDE采用Jbuilder,Eclipse或IdeaIntellJ其中的
4、一種,其他開發(fā)工具不予選取。一個項目統(tǒng)一使用其中某一種IDE。版本控制工具采用VisualSourceSafe。3代碼規(guī)范3.1源文件規(guī)范3.1.1原文件后綴Java源文件使用.java作為文件后綴,java字節(jié)碼文件使用.class作為文件后綴。3.1.2常用類名約定3.1.2.1異常類名將最后作為Exception的類名.例:ClassNameEndsWithException3.1.2.2接口名同類名.但是,如果有和class區(qū)別的必要的話,最開始加I.例:IAdviceHandle。如果增
5、加類中的某些能力時,作為表示其能力的形容詞,將-able當(dāng)作接尾.例:Runnable,Clonabe,Serializable,…第24頁共27頁廣州普翔軟件科技有限公司1.1.1.1實(shí)現(xiàn)類名特別是有和interface區(qū)別的必要的話,最后加Impl.例:ClassNameEndsImpl1.1.1.2抽象類名從Abstract開始,起一個聯(lián)想SubClass名的名字.例:AbstractDAOImpl1.1.2文件組織1.1.2.1類定義每個java源文件都包含單一的公共類或接口,若私有類和接
6、口只與一個公共類相關(guān)聯(lián),可以將它們和公共類放在同一個源文件.公共類必須是這個文件中的第一個類或接口.1.1.2.2文件結(jié)構(gòu)Java源文件遵循以下規(guī)則:?開頭注釋所有的源文件都應(yīng)有一個C語言風(fēng)格的注釋,其中列出類名,版本信息,日期和版權(quán)聲明:/***Classname類名稱**Versioninformation版本信息**Date日期**Copyrightnotice版權(quán)聲明*/?包和引入語句在多數(shù)的Java源文件中,第一個非注釋行是包語句,在它之后可以跟引入語句.第24頁共27頁廣州普翔軟件科技
7、有限公司例:packageorg.omg.CORBAimportorg.omg.CORBA.ARG_INOUT;?類和接口聲明下表描述了類和接口聲明的各個部分和它們出現(xiàn)的先后次序.類/接口聲明的各部分注解1類/接口文檔注釋(/**……*/)該注釋中所需包含的信息.2類或接口的聲明3類/接口實(shí)現(xiàn)的注釋(/*……*/)如果有必要的話該注釋應(yīng)包含任何有關(guān)整個類或接口的信息,而這些信息又不適合作為類/接口文檔注釋。4類的(靜態(tài))變量首先是類的公共變量,隨后是保護(hù)變量,再后是包一級別的變量(沒有訪問修飾符,
8、accessmodifier),最后是私有變量。5實(shí)例變量首先是公共級別的,隨后是保護(hù)級別的,再后是包一級別的(沒有訪問修飾符),最后是私有級別的。6構(gòu)造器遵循傳入?yún)?shù)多少,進(jìn)行排列.7方法第24頁共27頁廣州普翔軟件科技有限公司這些方法應(yīng)該按功能,而非作用域或訪問權(quán)限,分組。例如,一個私有的類方法可以置于兩個公有的實(shí)例方法之間。其目的是為了更便于閱讀和理解代碼。1.1.1編碼格式1.1.1.1文件代碼行長度一個文件由被空行分割而成的段落以及標(biāo)識每個段落的可選注釋共同組成,超過20