作者：zergman
email: zergman@chinaasp.com
日期：2001-6-15 13:24:42
[BLOCKQUOTE][BLOCKQUOTE][BLOCKQUOTE][BLOCKQUOTE][BLOCKQUOTE][BLOCKQUOTE]
[b]Java 程序編碼規(guī)范[/b]
[b][/b][/BLOCKQUOTE][/BLOCKQUOTE][/BLOCKQUOTE][/BLOCKQUOTE][/BLOCKQUOTE][/BLOCKQUOTE]
李小敏
www.yway.com 軟件工程師
2000年12月
[TABLE][TR][TD][#ffffff][B]內(nèi)容:[/B][/#][/TD][/TR][TR][TD][img]http://www.cn.ibm.com/developerWorks/i/c.gif[/img][/TD][/TR][TR][TD][img]http://www.cn.ibm.com/developerWorks/i/c.gif[/img][/TD][/TR][TR][TD] [url href=http://www.cn.ibm.com/developerWorks/java/java_standard/index.shtml#1]命名慣例[/url][/TD][/TR][TR][TD] [url href=http://www.cn.ibm.com/developerWorks/java/java_standard/index.shtml#2]Java文件樣式[/url][/TD][/TR][TR][TD] [url href=http://www.cn.ibm.com/developerWorks/java/java_standard/index.shtml#3]代碼編寫格式[/url][/TD][/TR][TR][TD] [url href=http://www.cn.ibm.com/developerWorks/java/java_standard/index.shtml#4]程序編寫[/url][/TD][/TR][TR][TD] [url href=http://www.cn.ibm.com/developerWorks/java/java_standard/index.shtml#5]編程技巧[/url][/TD][/TR][TR][TD] [url href=http://www.cn.ibm.com/developerWorks/java/java_standard/index.shtml#6]Swing[/url][/TD][/TR][TR][TD] [url href=http://www.cn.ibm.com/developerWorks/java/java_standard/index.shtml#7]調(diào)試[/url][/TD][/TR][TR][TD] [url href=http://www.cn.ibm.com/developerWorks/java/java_standard/index.shtml#8]性能[/url][/TD][/TR][TR][TD] [url href=http://www.cn.ibm.com/developerWorks/java/java_standard/index.shtml#9]可移植性[/url][/TD][/TR][TR][TD] [url href=http://www.cn.ibm.com/developerWorks/java/java_standard/index.shtml#resources]參考資料[/url][/TD][/TR][TR][TD] [url href=http://www.cn.ibm.com/developerWorks/java/java_standard/index.shtml#author]作者簡介[/url][/TD][/TR][TR][TD][img]http://www.cn.ibm.com/developerWorks/i/c.gif[/img][/TD][/TR][/TABLE]
[i]    所有的程序開發(fā)手冊都包含了各種規(guī)則。一些習(xí)慣自由程序人員可能對這些規(guī)則很不適應(yīng)，但是在多個開發(fā)人員共同寫作的情況下，這些規(guī)則是必需的。這不僅僅是為了開發(fā)效率來考慮，而且也是為了后期維護(hù)考慮。[/i]
[b]命名規(guī)范[/b] 
定義這個規(guī)范的目的是讓項(xiàng)目中所有的文檔都看起來像一個人寫的，增加可讀性，減少項(xiàng)目組中因?yàn)閾Q人而帶來的損失。（這些規(guī)范并不是一定要絕對遵守，但是一定要讓程序有良好的可讀性） 
[UL][LI]Package 的命名 
Package 的名字應(yīng)該都是由一個小寫單詞組成。 [/LI][/UL][UL][LI]Class 的命名 
Class 的名字必須由大寫字母開頭而其他字母都小寫的單詞組成 [/LI][/UL][UL][LI]Class 變量的命名 
變量的名字必須用一個小寫字母開頭。后面的單詞用大寫字母開頭。 [/LI][/UL][UL][LI]Static Final 變量的命名 
Static Final 變量的名字應(yīng)該都大寫，并且指出完整含義。 [/LI][/UL][UL][LI]參數(shù)的命名 
參數(shù)的名字必須和變量的命名規(guī)范一致。 [/LI][/UL][UL][LI]數(shù)組的命名 
數(shù)組應(yīng)該總是用下面的方式來命名： [TABLE][TR][TD]
[PRE]byte[] buffer;		[/PRE][/TD][/TR][/TABLE]而不是： [TABLE][TR][TD]
[PRE]byte buffer[];		[/PRE][/TD][/TR][/TABLE][/LI][/UL][UL][LI]方法的參數(shù) 
使用有意義的參數(shù)命名，如果可能的話，使用和要賦值的字段一樣的名字： [TABLE][TR][TD]
[PRE]SetCounter(int size){	this.size = size;}		[/PRE][/TD][/TR][/TABLE][/LI][/UL]

[b]Java 文件樣式[/b] 
所有的 Java(*.java) 文件都必須遵守如下的樣式規(guī)則 
[UL][LI]版權(quán)信息 
版權(quán)信息必須在 java 文件的開頭，比如： [TABLE][TR][TD]
[PRE]/** * Copyright ® 2000 Shanghai XXX Co. Ltd. * All right reserved. */		[/PRE][/TD][/TR][/TABLE]其他不需要出現(xiàn)在 javadoc 的信息也可以包含在這里。

[/LI][/UL][UL][LI]Package/Imports 
package 行要在 import 行之前，import 中標(biāo)準(zhǔn)的包名要在本地的包名之前，而且按照字母順序排列。如果 import 行中包含了同一個包中的不同子目錄，則應(yīng)該用 * 來處理。 [TABLE][TR][TD]
[PRE]package hotlava.net.stats;import java.io.*;import java.util.Observable;import hotlava.util.Application;		[/PRE][/TD][/TR][/TABLE]這里 java.io.* 使用來代替InputStream and OutputStream 的。

[/LI][/UL][UL][LI]Class 
接下來的是類的注釋，一般是用來解釋類的。 [TABLE][TR][TD]
[PRE]/** * 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 */		[/PRE][/TD][/TR][/TABLE]接下來是類定義，包含了在不同的行的 extends 和 implements [TABLE][TR][TD]
[PRE]public class CounterSet		extends Observable		implements Cloneable		[/PRE][/TD][/TR][/TABLE][/LI][/UL][UL][LI]Class Fields 
接下來是類的成員變量： [TABLE][TR][TD]
[PRE]/** * Packet counters */protected int[] packets;[/PRE][/TD][/TR][/TABLE]public 的成員變量必須生成文檔（JavaDoc）。proceted、private和 package 定義的成員變量如果名字含義明確的話，可以沒有注釋。

[/LI][/UL][UL][LI]存取方法 
接下來是類變量的存取的方法。它只是簡單的用來將類的變量賦值獲取值的話，可以簡單的寫在一行上。 [TABLE][TR][TD]
[PRE]/** * 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; }[/PRE][/TD][/TR][/TABLE]其它的方法不要寫在一行上

[/LI][/UL][UL][LI]構(gòu)造函數(shù) 
接下來是構(gòu)造函數(shù)，它應(yīng)該用遞增的方式寫（比如：參數(shù)多的寫在后面）。 
訪問類型 ("public", "private" 等.) 和 任何 "static", "final" 或 "synchronized" 應(yīng)該在一行中，并且方法和參數(shù)另寫一行，這樣可以使方法和參數(shù)更易讀。 [TABLE][TR][TD]
[PRE]publicCounterSet(int size){  this.size = size;}[/PRE][/TD][/TR][/TABLE][/LI][/UL][UL][LI]克隆方法 
如果這個類是可以被克隆的，那么下一步就是 clone 方法： [TABLE][TR][TD]
[PRE]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());  }}[/PRE][/TD][/TR][/TABLE][/LI][/UL][UL][LI]類方法 
下面開始寫類的方法： [TABLE][TR][TD]
[PRE]/** * 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);}[/PRE][/TD][/TR][/TABLE][/LI][/UL][UL][LI]toString 方法 
無論如何，每一個類都應(yīng)該定義 toString 方法： [TABLE][TR][TD]
[PRE]publicString toString() {  String retval = "CounterSet: ";    for (int i = 0; i < data.length(); i++) {      retval += data.bytes.toString();      retval += data.packets.toString();    }    return retval;  }}[/PRE][/TD][/TR][/TABLE][/LI][/UL][UL][LI]main 方法 
如果main(String[]) 方法已經(jīng)定義了, 那么它應(yīng)該寫在類的底部. [/LI][/UL]

[b]代碼編寫格式[/b] 
[UL][LI]代碼樣式 
代碼應(yīng)該用 unix 的格式，而不是 windows 的（比如：回車變成回車+換行） [/LI][/UL][UL][LI]文檔化 
必須用 javadoc 來為類生成文檔。不僅因?yàn)樗菢?biāo)準(zhǔn)，這也是被各種 java 編譯器都認(rèn)可的方法。使用 @author 標(biāo)記是不被推薦的，因?yàn)榇a不應(yīng)該是被個人擁有的。 [/LI][/UL][UL][LI]縮進(jìn) 
縮進(jìn)應(yīng)該是每行2個空格. 不要在源文件中保存Tab字符. 在使用不同的源代碼管理工具時Tab字符將因?yàn)橛脩粼O(shè)置的不同而擴(kuò)展為不同的寬度. 
如果你使用 UltrEdit 作為你的 Java 源代碼編輯器的話，你可以通過如下操作來禁止保存Tab字符, 方法是通過 UltrEdit中先設(shè)定 Tab 使用的長度室2個空格，然后用 Format|Tabs to Spaces 菜單將 Tab 轉(zhuǎn)換為空格。 [/LI][/UL][UL][LI]頁寬 
頁寬應(yīng)該設(shè)置為80字符. 源代碼一般不會超過這個寬度, 并導(dǎo)致無法完整顯示, 但這一設(shè)置也可以靈活調(diào)整. 在任何情況下, 超長的語句應(yīng)該在一個逗號或者一個操作符后折行. 一條語句折行后, 應(yīng)該比原來的語句再縮進(jìn)2個字符. [/LI][/UL][UL][LI]{} 對 
{} 中的語句應(yīng)該單獨(dú)作為一行. 例如, 下面的第1行是錯誤的, 第2行是正確的: [TABLE][TR][TD]
[PRE]if (i>0) { i ++ }; // 錯誤, { 和 } 在同一行 if (i>0) { i ++ };       // 正確, { 單獨(dú)作為一行 } 語句永遠(yuǎn)單獨(dú)作為一行. [/PRE][/TD][/TR][/TABLE]如果 } 語句應(yīng)該縮進(jìn)到與其相對應(yīng)的 { 那一行相對齊的位置。

[/LI][/UL][UL][LI]括號 
左括號和后一個字符之間不應(yīng)該出現(xiàn)空格, 同樣, 右括號和前一個字符之間也不應(yīng)該出現(xiàn)空格. 下面的例子說明括號和空格的錯誤及正確使用: 

CallProc( AParameter ); // 錯誤 
CallProc(AParameter); // 正確 

不要在語句中使用無意義的括號. 括號只應(yīng)該為達(dá)到某種目的而出現(xiàn)在源代碼中。下面的例子說明錯誤和正確的用法: 

if ((I) = 42) { // 錯誤 - 括號毫無意義 
if (I == 42) or (J == 42) then // 正確 - 的確需要括號 
[/LI][/UL]

[b]程序編寫規(guī)范[/b] 
[UL][LI]exit() 
exit 除了在 main 中可以被調(diào)用外，其他的地方不應(yīng)該調(diào)用。因?yàn)檫@樣做不給任何代碼代碼機(jī)會來截獲退出。一個類似后臺服務(wù)地程序不應(yīng)該因?yàn)槟骋粋€庫模塊決定了要退出就退出。 [/LI][/UL][UL][LI]異常 
申明的錯誤應(yīng)該拋出一個RuntimeException或者派生的異常。 
頂層的main()函數(shù)應(yīng)該截獲所有的異常，并且打印（或者記錄在日志中）在屏幕上。 [/LI][/UL][UL][LI]垃圾收集 
JAVA使用成熟的后臺垃圾收集技術(shù)來代替引用計(jì)數(shù)。但是這樣會導(dǎo)致一個問題：你必須在使用完對象的實(shí)例以后進(jìn)行清場工作。比如一個prel的程序員可能這么寫： [TABLE][TR][TD]