軟件開(kāi)發(fā)過(guò)程文檔 JAVA編碼規(guī)約

1、計(jì)算機(jī)源代碼編寫(xiě)規(guī)范(JAVA編碼規(guī)范) 編 號(hào)：MPDK/ZY-15-2007修 改 號(hào)：0發(fā) 放 號(hào)：發(fā)布時(shí)間：2007-06-28實(shí)施時(shí)間：2007-06-28編 制：批 準(zhǔn)：JAVA編程規(guī)范JAVA編程規(guī)范11目的12適用范圍13規(guī)范內(nèi)容11 目的定義這個(gè)規(guī)范的目的是讓項(xiàng)目中所有的文檔都看起來(lái)像一個(gè)人寫(xiě)的，增加可讀性，減少項(xiàng)目組中因?yàn)閾Q人而帶來(lái)的損失。（這些規(guī)范并不是一定要絕對(duì)遵守，但是一定要讓程序有良好的可讀性） 2 適用范圍適合公司所有的JAVA語(yǔ)言編程項(xiàng)目。3 規(guī)范內(nèi)容3.1 命名規(guī)定Package 的命名 Package 的名字應(yīng)該都是由一個(gè)小寫(xiě)單詞組成。 Class 的命名

2、Class 的名字必須由大寫(xiě)字母開(kāi)頭而其他字母都小寫(xiě)的單詞組成 Class 變量的命名 變量的名字必須用一個(gè)小寫(xiě)字母開(kāi)頭。后面的單詞用大寫(xiě)字母開(kāi)頭。 Static Final 變量的命名 Static Final 變量的名字應(yīng)該都大寫(xiě)，并且指出完整含義。 參數(shù)的命名 參數(shù)的名字必須和變量的命名規(guī)范一致。 數(shù)組的命名 數(shù)組應(yīng)該總是用下面的方式來(lái)命名： byte buffer; 而不是： byte buffer; 方法的參數(shù) 使用有意義的參數(shù)命名，如果可能的話(huà)，使用和要賦值的字段一樣的名字： SetCounter(int size) this.size = size; Java 文件樣式 所有的

3、Java(*.java) 文件都必須遵守如下的樣式規(guī)則 版權(quán)信息 版權(quán)信息必須在 java 文件的開(kāi)頭，比如： /* * Copyright ® 2000 Shanghai XXX Co. Ltd. * All right reserved. */ 其他不需要出現(xiàn)在 javadoc 的信息也可以包含在這里。 Package/Imports package 行要在 import 行之前，import 中標(biāo)準(zhǔn)的包名要在本地的包名之前，而且按照字母順序排列。如果 import 行中包含了同一個(gè)包中的不同子目錄，則應(yīng)該用 * 來(lái)處理。 package .stats; import ja

4、va.io.*; import java.util.Observable; import hotlava.util.Application; 這里 java.io.* 使用來(lái)代替InputStream and OutputStream 的。 Class 接下來(lái)的是類(lèi)的注釋?zhuān)话闶怯脕?lái)解釋類(lèi)的。 /* * A class representing a set of packet and byte counters * It is observable to allow it to be watched, but only * reports changes when the current se

5、t is complete */ 接下來(lái)是類(lèi)定義，包含了在不同的行的 extends 和 implements public class CounterSet extends Observable implements Cloneable Class Fields 接下來(lái)是類(lèi)的成員變量： /* * Packet counters */ protected int packets; public 的成員變量必須生成文檔（JavaDoc）。proceted、private和 package 定義的成員變量如果名字含義明確的話(huà)，可以沒(méi)有注釋。 存取方法 接下來(lái)是類(lèi)變量的存取的方法。它只是簡(jiǎn)單的用來(lái)將

6、類(lèi)的變量賦值獲取值的話(huà)，可以簡(jiǎn)單的寫(xiě)在一行上。 /* * Get the counters * return an array containing the statistical data. This array has been * freshly allocated and can be modified by the caller. */ public int getPackets() return copyArray(packets, offset); public int getBytes() return copyArray(bytes, offset); public int

7、getPackets() return packets; public void setPackets(int packets) this.packets = packets; 其它的方法不要寫(xiě)在一行上 構(gòu)造函數(shù) 接下來(lái)是構(gòu)造函數(shù)，它應(yīng)該用遞增的方式寫(xiě)（比如：參數(shù)多的寫(xiě)在后面）。 訪(fǎng)問(wèn)類(lèi)型 ("public", "private" 等.) 和 任何 "static", "final" 或 "synchronized" 應(yīng)該在一行中，并且方法和參數(shù)另寫(xiě)一行，這樣可以使方法和參數(shù)更易讀。 publi

8、c CounterSet(int size) this.size = size; 克隆方法 如果這個(gè)類(lèi)是可以被克隆的，那么下一步就是 clone 方法： public Object clone() try CounterSet obj = (CounterSet)super.clone(); obj.packets = (int)packets.clone(); obj.size = size; return obj; catch(CloneNotSupportedException e) throw new InternalError("Unexpected CloneNotSUp

9、portedException: " + e.getMessage(); 類(lèi)方法 下面開(kāi)始寫(xiě)類(lèi)的方法： /* * Set the packet counters * (such as when restoring from a database) */ protected final void setArray(int r1, int r2, int r3, int r4) throws IllegalArgumentException / / Ensure the arrays are of equal size / if (r1.length != r2.length | r1.

10、length != r3.length | r1.length != r4.length) throw new IllegalArgumentException("Arrays must be of the same size"); System.arraycopy(r1, 0, r3, 0, r1.length); System.arraycopy(r2, 0, r4, 0, r1.length); toString 方法 無(wú)論如何，每一個(gè)類(lèi)都應(yīng)該定義 toString 方法： public String toString() String retval = "

11、CounterSet: " for (int i = 0; i < data.length(); i+) retval += data.bytes.toString(); retval += data.packets.toString(); return retval; main 方法 如果main(String) 方法已經(jīng)定義了, 那么它應(yīng)該寫(xiě)在類(lèi)的底部. 代碼編寫(xiě)格式 代碼樣式 代碼應(yīng)該用 unix 的格式，而不是 windows 的（比如：回車(chē)變成回車(chē)+換行） 文檔化 必須用 javadoc 來(lái)為類(lèi)生成文檔。不僅因?yàn)樗菢?biāo)準(zhǔn)，這也是被各種 java 編譯器都認(rèn)可的

12、方法。使用 author 標(biāo)記是不被推薦的，因?yàn)榇a不應(yīng)該是被個(gè)人擁有的。 縮進(jìn) 縮進(jìn)應(yīng)該是每行2個(gè)空格. 不要在源文件中保存Tab字符. 在使用不同的源代碼管理工具時(shí)Tab字符將因?yàn)橛脩?hù)設(shè)置的不同而擴(kuò)展為不同的寬度. 如果你使用 UltrEdit 作為你的 Java 源代碼編輯器的話(huà)，你可以通過(guò)如下操作來(lái)禁止保存Tab字符, 方法是通過(guò) UltrEdit中先設(shè)定 Tab 使用的長(zhǎng)度室2個(gè)空格，然后用 Format|Tabs to Spaces 菜單將 Tab 轉(zhuǎn)換為空格。 頁(yè)寬 頁(yè)寬應(yīng)該設(shè)置為80字符. 源代碼一般不會(huì)超過(guò)這個(gè)寬度, 并導(dǎo)致無(wú)法完整顯示, 但這一設(shè)置也可以靈活調(diào)整. 在任何情

13、況下, 超長(zhǎng)的語(yǔ)句應(yīng)該在一個(gè)逗號(hào)或者一個(gè)操作符后折行. 一條語(yǔ)句折行后, 應(yīng)該比原來(lái)的語(yǔ)句再縮進(jìn)2個(gè)字符. 對(duì) 中的語(yǔ)句應(yīng)該單獨(dú)作為一行. 例如, 下面的第1行是錯(cuò)誤的, 第2行是正確的: if (i>0) i + ; / 錯(cuò)誤, 和 在同一行 if (i>0) i + ; / 正確, 單獨(dú)作為一行 語(yǔ)句永遠(yuǎn)單獨(dú)作為一行. 如果 語(yǔ)句應(yīng)該縮進(jìn)到與其相對(duì)應(yīng)的 那一行相對(duì)齊的位置。 括號(hào) 左括號(hào)和后一個(gè)字符之間不應(yīng)該出現(xiàn)空格, 同樣, 右括號(hào)和前一個(gè)字符之間也不應(yīng)該出現(xiàn)空格. 下面的例子說(shuō)明括號(hào)和空格的錯(cuò)誤及正確使用: CallProc( AParameter ); /

14、 錯(cuò)誤 CallProc(AParameter); / 正確 不要在語(yǔ)句中使用無(wú)意義的括號(hào). 括號(hào)只應(yīng)該為達(dá)到某種目的而出現(xiàn)在源代碼中。下面的例子說(shuō)明錯(cuò)誤和正確的用法: if (I) = 42) / 錯(cuò)誤 - 括號(hào)毫無(wú)意義 if (I = 42) or (J = 42) then / 正確 - 的確需要括號(hào) 程序編寫(xiě)規(guī)范 exit() exit 除了在 main 中可以被調(diào)用外，其他的地方不應(yīng)該調(diào)用。因?yàn)檫@樣做不給任何代碼代碼機(jī)會(huì)來(lái)截獲退出。一個(gè)類(lèi)似后臺(tái)服務(wù)地程序不應(yīng)該因?yàn)槟骋粋€(gè)庫(kù)模塊決定了要退出就退出。 異常 申明的錯(cuò)誤應(yīng)該拋出一個(gè)RuntimeException或者派生的異常。 頂層的ma

15、in()函數(shù)應(yīng)該截獲所有的異常，并且打?。ɑ蛘哂涗浽谌罩局校┰谄聊簧?。 垃圾收集 JAVA使用成熟的后臺(tái)垃圾收集技術(shù)來(lái)代替引用計(jì)數(shù)。但是這樣會(huì)導(dǎo)致一個(gè)問(wèn)題：你必須在使用完對(duì)象的實(shí)例以后進(jìn)行清場(chǎng)工作。比如一個(gè)prel的程序員可能這么寫(xiě)： . FileOutputStream fos = new FileOutputStream(projectFile); project.save(fos, "IDE Project File"); . 除非輸出流一出作用域就關(guān)閉，非引用計(jì)數(shù)的程序語(yǔ)言，比如JAVA，是不能自動(dòng)完成變量的清場(chǎng)工作的。必須象下面一樣寫(xiě)： FileOutputStr

16、eam fos = new FileOutputStream(projectFile); project.save(fos, "IDE Project File"); fos.close(); Clone 下面是一種有用的方法： implements Cloneable public Object clone() try ThisClass obj = (ThisClass)super.clone(); obj.field1 = (int)field1.clone(); obj.field2 = field2; return obj; catch(CloneNotSupportedException e) throw new InternalError("Unexpected CloneNotSUpportedException: " + e.getMessage(); final 類(lèi) 絕對(duì)不要因?yàn)樾阅艿脑驅(qū)㈩?lèi)定義為 final 的（除非程序的框架要求） 如果一個(gè)類(lèi)還沒(méi)有準(zhǔn)備好被繼承，最好在類(lèi)文檔