JAVA編程規(guī)范28294

1、JAVA編程規(guī)范定義這個規(guī)范的目的是讓項目中所有的文檔都看起來像一個人寫的，增加可讀性，減少項目組中因為換人而帶來的損失。（這些規(guī)范并不是一定要絕對遵守，但是一定要讓程序有良好的可讀性） Package的命名 Package的名字應(yīng)該都是由一個小寫單詞組成。 Class的命名 Class的名字必須由大寫字母開頭而其他字母都小寫的單詞組成 Class變量的命名 變量的名字必須用一個小寫字母開頭。后面的單詞用大寫字母開頭。 StaticFinal變量的命名 StaticFinal變量的名字應(yīng)該都大寫，并且指出完整含義。 參數(shù)的命名 參數(shù)的名字必須和變量的命名規(guī)范一致。 數(shù)組的命名 數(shù)組應(yīng)該總是用下

2、面的方式來命名： bytebuffer; 而不是： bytebuffer; 方法的參數(shù) 使用有意義的參數(shù)命名，如果可能的話，使用和要賦值的字段一樣的名字： SetCounter(intsize) this.size=size; Java文件樣式 所有的Java(*.java)文件都必須遵守如下的樣式規(guī)則 版權(quán)信息 版權(quán)信息必須在java文件的開頭，比如： /* *Copyright®2000ShanghaiXXXCo.Ltd. *Allrightreserved. */ 其他不需要出現(xiàn)在javadoc的信息也可以包含在這里。 Package/Imports package行要在impo

3、rt行之前，import中標(biāo)準(zhǔn)的包名要在本地的包名之前，而且按照字母順序排列。如果import行中包含了同一個包中的不同子目錄，則應(yīng)該用*來處理。 .stats; importjava.io.*; importjava.util.Observable; importhotlava.util.Application; 這里java.io.*使用來代替InputStreamandOutputStream的。 Class 接下來的是類的注釋，一般是用來解釋類的。 /* *Aclassrepresentingasetofpacketandbytecounters *Itisobservabletoal

4、lowittobewatched,butonly *reportschangeswhenthecurrentsetiscomplete */ 接下來是類定義，包含了在不同的行的extends和implements publicclassCounterSet extendsObservable implementsCloneable ClassFields 接下來是類的成員變量： /* *Packetcounters */ protectedintpackets; public的成員變量必須生成文檔（JavaDoc）。proceted、private和package定義的成員變量如果名字含義明確

5、的話，可以沒有注釋。 存取方法 接下來是類變量的存取的方法。它只是簡單的用來將類的變量賦值獲取值的話，可以簡單的寫在一行上。 /* *Getthecounters *returnanarraycontainingthestatisticaldata.Thisarrayhasbeen *freshlyallocatedandcanbemodifiedbythecaller. */ publicintgetPackets()returncopyArray(packets,offset); publicintgetBytes()returncopyArray(bytes,offset); publi

6、cintgetPackets()returnpackets; publicvoidsetPackets(intpackets)this.packets=packets; 其它的方法不要寫在一行上 構(gòu)造函數(shù) 接下來是構(gòu)造函數(shù)，它應(yīng)該用遞增的方式寫（比如：參數(shù)多的寫在后面）。 訪問類型(public,private等.)和任何static,final或synchronized應(yīng)該在一行中，并且方法和參數(shù)另寫一行，這樣可以使方法和參數(shù)更易讀。 public CounterSet(intsize) this.size=size; 克隆方法 如果這個類是可以被克隆的，那么下一步就是clone方法： pu

7、blic Objectclone() try CounterSetobj=(CounterSet)super.clone(); obj.packets=(int)packets.clone(); obj.size=size; returnobj; catch(CloneNotSupportedExceptione) thrownewInternalError(UnexpectedCloneNotSUpportedException:+e.getMessage(); 類方法 下面開始寫類的方法： /* *Setthepacketcounters *(suchaswhenrestoringfrom

8、adatabase) */ protectedfinal voidsetArray(intr1,intr2,intr3,intr4) throwsIllegalArgumentException / /Ensurethearraysareofequalsize / if(r1.length!=r2.length|r1.length!=r3.length|r1.length!=r4.length) thrownewIllegalArgumentException(Arraysmustbeofthesamesize); System.arraycopy(r1,0,r3,0,r1.length);

9、System.arraycopy(r2,0,r4,0,r1.length); toString方法 無論如何，每一個類都應(yīng)該定義toString方法： public StringtoString() Stringretval=CounterSet:; for(inti=0;i0)i+;/錯誤,和在同一行 if(i0) i+ ;/正確,單獨作為一行 語句永遠(yuǎn)單獨作為一行. 如果語句應(yīng)該縮進到與其相對應(yīng)的那一行相對齊的位置。 括號 左括號和后一個字符之間不應(yīng)該出現(xiàn)空格,同樣,右括號和前一個字符之間也不應(yīng)該出現(xiàn)空格.下面的例子說明括號和空格的錯誤及正確使用: CallProc(AParameter)

10、;/錯誤 CallProc(AParameter);/正確 不要在語句中使用無意義的括號.括號只應(yīng)該為達(dá)到某種目的而出現(xiàn)在源代碼中。下面的例子說明錯誤和正確的用法: if(I)=42)/錯誤-括號毫無意義 if(I=42)or(J=42)then/正確-的確需要括號 程序編寫規(guī)范 exit() exit除了在main中可以被調(diào)用外，其他的地方不應(yīng)該調(diào)用。因為這樣做不給任何代碼代碼機會來截獲退出。一個類似后臺服務(wù)地程序不應(yīng)該因為某一個庫模塊決定了要退出就退出。 異常 申明的錯誤應(yīng)該拋出一個RuntimeException或者派生的異常。 頂層的main()函數(shù)應(yīng)該截獲所有的異常，并且打?。ɑ蛘哂?/p>

11、錄在日志中）在屏幕上。 垃圾收集 JAVA使用成熟的后臺垃圾收集技術(shù)來代替引用計數(shù)。但是這樣會導(dǎo)致一個問題：你必須在使用完對象的實例以后進行清場工作。比如一個prel的程序員可能這么寫： . FileOutputStreamfos=newFileOutputStream(projectFile); project.save(fos,IDEProjectFile); . 除非輸出流一出作用域就關(guān)閉，非引用計數(shù)的程序語言，比如JAVA，是不能自動完成變量的清場工作的。必須象下面一樣寫： FileOutputStreamfos=newFileOutputStream(projectFile); pr

12、oject.save(fos,IDEProjectFile); fos.close(); Clone 下面是一種有用的方法： implementsCloneable public Objectclone() try ThisClassobj=(ThisClass)super.clone(); obj.field1=(int)field1.clone(); obj.field2=field2; returnobj; catch(CloneNotSupportedExceptione) thrownewInternalError(UnexpectedCloneNotSUpportedException:+e.getMessage(); final類 絕對不要因為性能的原因?qū)㈩惗x為final的（除非程序的框架要求） 如果一個類還沒有準(zhǔn)備好被繼承，最好在類文檔中注明，而不要將她定義為final的。這是因為沒有人可