李小敏
www.yway.com 軟件工程師
2000年12月
所有的程序開(kāi)發(fā)手冊都包含了各種規則。一些習慣自由程序人員可能對這些規則很不適應,但是在多個(gè)開(kāi)發(fā)人員共同寫(xiě)作的情況下,這些規則是必需的。這不僅僅是為了開(kāi)發(fā)效率來(lái)考慮,而且也是為了后期維護考慮。
命名規范
定義這個(gè)規范的目的是讓項目中所有的文檔都看起來(lái)像一個(gè)人寫(xiě)的,增加可讀性,減少項目組中因為換人而帶來(lái)的損失。(這些規范并不是一定要絕對遵守,但是一定要讓程序有良好的可讀性)
byte[] buffer; |
byte buffer[]; |
SetCounter(int size){ this.size = size;} |
Java 文件樣式 代碼編寫(xiě)格式 程序編寫(xiě)規范 編程技巧 Swing 調試 性能
所有的 Java(*.java) 文件都必須遵守如下的樣式規則
版權信息必須在 java 文件的開(kāi)頭,比如:
其他不需要出現在 javadoc 的信息也可以包含在這里。/** * Copyright ® 2000 Shanghai XXX Co. Ltd. * All right reserved. */
package 行要在 import 行之前,import 中標準的包名要在本地的包名之前,而且按照字母順序排列。如果 import 行中包含了同一個(gè)包中的不同子目錄,則應該用 * 來(lái)處理。
這里 java.io.* 使用來(lái)代替InputStream and OutputStream 的。package hotlava.net.stats;import java.io.*;import java.util.Observable;import hotlava.util.Application;
接下來(lái)的是類(lèi)的注釋?zhuān)话闶怯脕?lái)解釋類(lèi)的。
接下來(lái)是類(lèi)定義,包含了在不同的行的 extends 和 implements /** * 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 set is complete */
public class CounterSet extends Observable implements Cloneable
接下來(lái)是類(lèi)的成員變量:
public 的成員變量必須生成文檔(JavaDoc)。proceted、private和 package 定義的成員變量如果名字含義明確的話(huà),可以沒(méi)有注釋。/** * Packet counters */protected int[] packets;
接下來(lái)是類(lèi)變量的存取的方法。它只是簡(jiǎn)單的用來(lái)將類(lèi)的變量賦值獲取值的話(huà),可以簡(jiǎn)單的寫(xiě)在一行上。
其它的方法不要寫(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[] getPackets() { return packets; }public void setPackets(int[] packets) { this.packets = packets; }
接下來(lái)是構造函數,它應該用遞增的方式寫(xiě)(比如:參數多的寫(xiě)在后面)。
訪(fǎng)問(wèn)類(lèi)型 ("public", "private" 等.) 和 任何 "static", "final" 或 "synchronized" 應該在一行中,并且方法和參數另寫(xiě)一行,這樣可以使方法和參數更易讀。 publicCounterSet(int size){ this.size = size;}
如果這個(gè)類(lèi)是可以被克隆的,那么下一步就是 clone 方法: publicObject clone() { try { CounterSet obj = (CounterSet)super.clone(); obj.packets = (int[])packets.clone(); obj.size = size; return obj; }catch(CloneNotSupportedException e) { throw new InternalError("Unexpected CloneNotSUpportedException: " + e.getMessage()); }}
下面開(kāi)始寫(xiě)類(lèi)的方法: /** * Set the packet counters * (such as when restoring from a database) */protected finalvoid setArray(int[] r1, int[] r2, int[] r3, int[] r4) throws IllegalArgumentException{ // // Ensure the arrays are of equal size // if (r1.length != r2.length || r1.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);}
無(wú)論如何,每一個(gè)類(lèi)都應該定義 toString 方法: publicString toString() { String retval = "CounterSet: "; for (int i = 0; i < data.length(); i++) { retval += data.bytes.toString(); retval += data.packets.toString(); } return retval; }}
如果main(String[]) 方法已經(jīng)定義了, 那么它應該寫(xiě)在類(lèi)的底部.
代碼應該用 unix 的格式,而不是 windows 的(比如:回車(chē)變成回車(chē)+換行)
必須用 javadoc 來(lái)為類(lèi)生成文檔。不僅因為它是標準,這也是被各種 java 編譯器都認可的方法。使用 @author 標記是不被推薦的,因為代碼不應該是被個(gè)人擁有的。
縮進(jìn)應該是每行2個(gè)空格. 不要在源文件中保存Tab字符. 在使用不同的源代碼管理工具時(shí)Tab字符將因為用戶(hù)設置的不同而擴展為不同的寬度.
如果你使用 UltrEdit 作為你的 Java 源代碼編輯器的話(huà),你可以通過(guò)如下操作來(lái)禁止保存Tab字符, 方法是通過(guò) UltrEdit中先設定 Tab 使用的長(cháng)度室2個(gè)空格,然后用 Format|Tabs to Spaces 菜單將 Tab 轉換為空格。
頁(yè)寬應該設置為80字符. 源代碼一般不會(huì )超過(guò)這個(gè)寬度, 并導致無(wú)法完整顯示, 但這一設置也可以靈活調整. 在任何情況下, 超長(cháng)的語(yǔ)句應該在一個(gè)逗號或者一個(gè)操作符后折行. 一條語(yǔ)句折行后, 應該比原來(lái)的語(yǔ)句再縮進(jìn)2個(gè)字符.
{} 中的語(yǔ)句應該單獨作為一行. 例如, 下面的第1行是錯誤的, 第2行是正確的:
如果 } 語(yǔ)句應該縮進(jìn)到與其相對應的 { 那一行相對齊的位置。if (i>0) { i ++ }; // 錯誤, { 和 } 在同一行 if (i>0) { i ++ }; // 正確, { 單獨作為一行 } 語(yǔ)句永遠單獨作為一行.
左括號和后一個(gè)字符之間不應該出現空格, 同樣, 右括號和前一個(gè)字符之間也不應該出現空格. 下面的例子說(shuō)明括號和空格的錯誤及正確使用:
CallProc( AParameter ); // 錯誤
CallProc(AParameter); // 正確
不要在語(yǔ)句中使用無(wú)意義的括號. 括號只應該為達到某種目的而出現在源代碼中。下面的例子說(shuō)明錯誤和正確的用法:
if ((I) = 42) { // 錯誤 - 括號毫無(wú)意義
if (I == 42) or (J == 42) then // 正確 - 的確需要括號
exit 除了在 main 中可以被調用外,其他的地方不應該調用。因為這樣做不給任何代碼代碼機會(huì )來(lái)截獲退出。一個(gè)類(lèi)似后臺服務(wù)地程序不應該因為某一個(gè)庫模塊決定了要退出就退出。
申明的錯誤應該拋出一個(gè)RuntimeException或者派生的異常。
頂層的main()函數應該截獲所有的異常,并且打?。ɑ蛘哂涗浽谌罩局校┰谄聊簧?。
JAVA使用成熟的后臺垃圾收集技術(shù)來(lái)代替引用計數。但是這樣會(huì )導致一個(gè)問(wèn)題:你必須在使用完對象的實(shí)例以后進(jìn)行清場(chǎng)工作。比如一個(gè)prel的程序員可能這么寫(xiě):
除非輸出流一出作用域就關(guān)閉,非引用計數的程序語(yǔ)言,比如JAVA,是不能自動(dòng)完成變量的清場(chǎng)工作的。必須象下面一樣寫(xiě): ... { FileOutputStream fos = new FileOutputStream(projectFile); project.save(fos, "IDE Project File"); } ... FileOutputStream fos = new FileOutputStream(projectFile); project.save(fos, "IDE Project File"); fos.close();
下面是一種有用的方法: 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()); } }
絕對不要因為性能的原因將類(lèi)定義為 final 的(除非程序的框架要求)
如果一個(gè)類(lèi)還沒(méi)有準備好被繼承,最好在類(lèi)文檔中注明,而不要將她定義為 final 的。這是因為沒(méi)有人可以保證會(huì )不會(huì )由于什么原因需要繼承她。
大部分的類(lèi)成員變量應該定義為 protected 的來(lái)防止繼承類(lèi)使用他們。
注意,要用"int[] packets",而不是"int packets[]",后一種永遠也不要用。 public void setPackets(int[] packets) { this.packets = packets; } CounterSet(int size) { this.size = size; }
為了將 byte 數組轉換到 characters,你可以這么做:
"Hello world!".getBytes();
Utility 類(lèi)(僅僅提供方法的類(lèi))應該被申明為抽象的來(lái)防止被繼承或被初始化。
下面的代碼是一種很好的初始化數組的方法:
objectArguments = new Object[] { arguments };
JAVA 對枚舉的支持不好,但是下面的代碼是一種很有用的模板:
這種技術(shù)實(shí)現了RED, GREEN, BLUE 等可以象其他語(yǔ)言的枚舉類(lèi)型一樣使用的常量。 他們可以用 ‘==‘ 操作符來(lái)比較。 class Colour { public static final Colour BLACK = new Colour(0, 0, 0); public static final Colour RED = new Colour(0xFF, 0, 0); public static final Colour GREEN = new Colour(0, 0xFF, 0); public static final Colour BLUE = new Colour(0, 0, 0xFF); public static final Colour WHITE = new Colour(0xFF, 0xFF, 0xFF);}
但是這樣使用有一個(gè)缺陷:如果一個(gè)用戶(hù)用這樣的方法來(lái)創(chuàng )建顏色 BLACK
new Colour(0,0,0)
那么這就是另外一個(gè)對象,‘==‘操作符就會(huì )產(chǎn)生錯誤。她的 equal() 方法仍然有效。由于這個(gè)原因,這個(gè)技術(shù)的缺陷最好注明在文檔中,或者只在自己的包中使用。
如果要將 AWT 組件和 Swing 組件混合起來(lái)使用的話(huà),請小心使用。實(shí)際上,盡量不要將他們混合起來(lái)使用。
AWT 組件絕對不要用 JscrollPane 類(lèi)來(lái)實(shí)現滾動(dòng)。滾動(dòng) AWT 組件的時(shí)候一定要用 AWT ScrollPane 組件來(lái)實(shí)現。
盡量不要這么做,要不然會(huì )出現不可預料的后果。
AWT 組件總是顯示在 Swing 組件之上。當使用包含 AWT 組件的 POP-UP 菜單的時(shí)候要小心,盡量不要這樣使用。
很常用的一種調試方法就是用一個(gè) PrintStream 類(lèi)成員,在沒(méi)有定義調試流的時(shí)候就為 null,類(lèi)要定義一個(gè) debug 方法來(lái)設置調試用的流。
不是所有的人都同意在寫(xiě)代碼的時(shí)候應該優(yōu)化性能這個(gè)觀(guān)點(diǎn)的,他們認為性能優(yōu)化的問(wèn)題應該在項目的后期再去考慮,也就是在程序的輪廓已經(jīng)實(shí)現了以后。
在處理 String 的時(shí)候要盡量使用 StringBuffer 類(lèi),StringBuffer 類(lèi)是構成 String 類(lèi)的基礎。String 類(lèi)將 StringBuffer 類(lèi)封裝了起來(lái),(以花費更多時(shí)間為代價(jià))為開(kāi)發(fā)人員提供了一個(gè)安全的接口。當我們在構造字符串的時(shí)候,我們應該用 StringBuffer 來(lái)實(shí)現大部分的工作,當工作完成后將 StringBuffer 對象再轉換為需要的 String 對象。比如:如果有一個(gè)字符串必須不斷地在其后添加許多字符來(lái)完成構造,那么我們應該使用 StringBuffer 對象和她的 append() 方法。如果我們用 String 對象代替 StringBuffer 對象的話(huà),會(huì )花費許多不必要的創(chuàng )建和釋放對象的 CPU 時(shí)間。
避免不必要的使用關(guān)鍵字 synchronized,應該在必要的時(shí)候再使用她,這是一個(gè)避免死鎖的好方法。
聯(lián)系客服