資源描述:
《java 程序編碼規(guī)范》由會(huì)員上傳分享,免費(fèi)在線閱讀,更多相關(guān)內(nèi)容在行業(yè)資料-天天文庫(kù)。
1、Java程序編碼規(guī)范???命名規(guī)范定義這個(gè)規(guī)范的目的是讓項(xiàng)目中所有的文檔都看起來(lái)像一個(gè)人寫的,增加可讀性,減少項(xiàng)目組中因?yàn)閾Q人而帶來(lái)的損失。(這些規(guī)范并不是一定要絕對(duì)遵守,但是一定要讓程序有良好的可讀性)·Package的命名Package的名字應(yīng)該都是由一個(gè)小寫單詞組成?!lass的命名Class的名字必須由大寫字母開頭而其他字母都小寫的單詞組成·Class變量的命名變量的名字必須用一個(gè)小寫字母開頭。后面的單詞用大寫字母開頭?!taticFinal變量的命名StaticFinal變量的名字應(yīng)該都大寫,并且指出完整含義?!?shù)的
2、命名參數(shù)的名字必須和變量的命名規(guī)范一致。·數(shù)組的命名數(shù)組應(yīng)該總是用下面的方式來(lái)命名:byte[]buffer;·而不是:bytebuffer[];·方法的參數(shù)使用有意義的參數(shù)命名,如果可能的話,使用和要賦值的字段一樣的名字:SetCounter(intsize){this.size=size;}intgetCounter(){……returncounter;}Java文件樣式所有的Java(*.java)文件都必須遵守如下的樣式規(guī)則,推薦使用VisualAgeforJava,這樣的話,很多如下的工作都可以由它完成?!ぐ鏅?quán)信息版權(quán)信息
3、必須在java文件的開頭,比如:/***Copyright?2000ShanghaiXXXCo.Ltd.*Allrightreserved.*/·其他不需要出現(xiàn)在javadoc的信息也可以包含在這里。·Package/Importspackage行要在import行之前,而且必須出現(xiàn)在java程序文件的第一行!import中標(biāo)準(zhǔn)的包名要在本地的包名之前,而且按照字母順序排列。如果import行中包含了同一個(gè)包中的不同子目錄,則應(yīng)該用*來(lái)處理。packagehotlava.net.stats;importjava.io.*;impor
4、tjava.util.Observable;importhotlava.util.Application;·這里java.io.*使用來(lái)代替InputStreamandOutputStream的?!lass接下來(lái)的是類的注釋,一般是用來(lái)解釋類的。/***Aclassrepresentingasetofpacketandbytecounters*Itisobservabletoallowittobewatched,butonly*reportschangeswhenthecurrentsetiscomplete*/·接下來(lái)是類定義,
5、包含了在不同的行的extends和implementspublicclassCounterSetextendsObservableimplementsCloneable·ClassFields接下來(lái)是類的成員變量:/***Packetcounters*/protectedint[]packets;·public的成員變量必須生成文檔(JavaDoc)。proceted、private和package定義的成員變量如果名字含義明確的話,可以沒有注釋。·存取方法接下來(lái)是類變量的存取的方法。它只是簡(jiǎn)單的用來(lái)將類的變量賦值獲取值的話,可以簡(jiǎn)
6、單的寫在一行上。/***Getthecounters*@returnanarraycontainingthestatisticaldata.Thisarrayhasbeen*freshlyallocatedandcanbemodifiedbythecaller.*/publicint[]getPackets(){returncopyArray(packets,offset);}publicint[]getBytes(){returncopyArray(bytes,offset);}publicint[]getPackets(){re
7、turnpackets;}publicvoidsetPackets(int[]packets){this.packets=packets;}·其它的方法不要寫在一行上·構(gòu)造函數(shù)接下來(lái)是構(gòu)造函數(shù),它應(yīng)該用遞增的方式寫(比如:參數(shù)多的寫在后面)。訪問(wèn)類型("public","private"等.)和任何"static","final"或"synchronized"應(yīng)該在一行中,并且方法和參數(shù)另寫一行,這樣可以使方法和參數(shù)更易讀。publicCounterSet(intsize){this.size=size;}·克隆方法如果這個(gè)類是可以
8、被克隆的,那么下一步就是clone方法:publicObjectclone(){try{CounterSetobj=(CounterSet)super.clone();obj.packets=(int[])packets.clone(