【正文】 bookName = null。 } public void Book() { }}. 空格下列情況建議使用單個(gè)空格（not tab）:在一個(gè)關(guān)鍵字和它所修飾的塊之間。下列關(guān)鍵字的后面請(qǐng)不要跟隨空格：super ，this 。例如：return true ；在一個(gè)列表中逗號(hào)之后。//RIGHT foo(long_expression1,long_expression2,long_expression3)。 //NOT GOOD右括號(hào)和前一個(gè)字符之間也不應(yīng)該出現(xiàn)空格，例如：if (i== 42)；//RIGHTif(i==42 )。由于在使用不同的源代碼管理工具時(shí)Tab字符將因?yàn)橛脩粼O(shè)置的不同而擴(kuò)展為不同的寬度，所以請(qǐng)不要使用tab鍵。. 行的延續(xù)代碼中的行應(yīng)該為80列，源代碼一般不會(huì)超過這個(gè)寬度, 如超過了80列應(yīng)該截成較短的行，建議超長(zhǎng)的語句應(yīng)該在一個(gè)逗號(hào)或者一個(gè)操作符后折行。例如：// 好的折行方式foo(long_expression1, long_expression2, long_expression3)。// 好的折行方式 if (long_logical_test_1 || long_logical_test2|| long_logical_test_3)//縮進(jìn)后與上一行l(wèi)ong_logical_test_1對(duì)齊{ statements。l 注釋要言簡(jiǎn)意賅。l 臨時(shí)的注釋用“temporary note”進(jìn)行標(biāo)注，以利于將來程序發(fā)布時(shí)將其刪去。 l 對(duì)于廣大的開發(fā)人員只要在源碼的編寫過程中注意加入適當(dāng)?shù)淖⑨?，則與源碼同步的文檔也就隨之產(chǎn)生。 2002 金質(zhì)工程版權(quán)所有。通常詳細(xì)介紹該類的功能，作者，版本，“deprecated標(biāo)志”的使用，以及產(chǎn)生該類的時(shí)間和引用其他類等信息。 * * pcodeMethod/code 介紹信息可以使用 HTML 標(biāo)記。對(duì)于這個(gè)標(biāo)記，javadoc會(huì)生成相應(yīng)的HTML，將其直接鏈接到其他文檔。注意javadoc不會(huì)檢查我們指定的超鏈接，不會(huì)驗(yàn)證它們是否有效。若在javadoc命令行使用了“version”標(biāo)記，就會(huì)從生成的HTML文檔里提取出版本信息。若在javadoc命令行使用了“author”標(biāo)記，就會(huì)專門從生成的HTML文檔里提取出作者信息。全部作者信息會(huì)一起存入最終HTML代碼的單獨(dú)一個(gè)段落里。該標(biāo)記用于指出一些舊功能已由改進(jìn)過的新功能取代。若將一個(gè)方法標(biāo)記為deprecated，則使用該方法時(shí)會(huì)收到編譯器的警告。但是為了提高項(xiàng)目的可讀性和可維護(hù)性，建議將所有的類成員都注釋。 * 它等于 * blockquotepre * code(0x7fefffffffffffffL)/code * /pre/blockquote * 的返回值。. 方法注釋方法注釋的注意內(nèi)容有方法功能介紹，參數(shù)說明，返回類型說明，例外類型，JDK/SDK 的引入版本等。 * * param s the string to be parsed. * return the double value represented by the string argument. * exception NumberFormatException if the string does not contain a * parsable double. * see valueOf(String) * since */解釋：param格式如下：param 參數(shù)名 說明其中，“參數(shù)名”是指參數(shù)列表內(nèi)的標(biāo)識(shí)符，而“說明”代表一些可延續(xù)到后續(xù)行內(nèi)的說明文字?？墒褂萌我鈹?shù)量的說明，每個(gè)參數(shù)一個(gè)。它可延續(xù)到后面的行內(nèi)。調(diào)用一個(gè)方法時(shí)，盡管只有一個(gè)違例對(duì)象出現(xiàn)，但一些特殊的方法也許能產(chǎn)生任意數(shù)量的、不同類型的違例。所以，違例標(biāo)記的格式如下：exception 完整類名 說明其中，“完整類名”明確指定了一個(gè)違例類的名字，它是在其他某個(gè)地方定義好的。since格式如下：since 說明利用說明內(nèi)容為文檔增加since標(biāo)題，表示從何時(shí)開始使用該方法或者類(以正式發(fā)布的版本為準(zhǔn))see. 內(nèi)部類的注釋 類注釋。并且用單行注釋符號(hào)注釋原行代碼。如下：//初始值設(shè)置錯(cuò)誤。String showMessage = “歡迎訪問！”。并且在該代碼的前一行注明注釋原因，注釋人員姓名和注釋日期。. 類體外的注釋類體外主要包括 package 和 import 語句。在引入新的類包的同時(shí)不需要指定引入人及日期等Log 信息。. 類類的組織順序建議如下順序：l 類的定義l 類的成員變量(字段/屬性)l 類成員變量(字段/屬性)的存取方法l 構(gòu)造函數(shù)l 類的方法l main()方法. 類的定義包含了在不同的行的 extends 和 implements public class CounterSet extends Observable implements Cloneable. 類的成員變量(字段/屬性)接下來是類的成員變量：/*** Packet counters*/protected int[] packets。 /** * 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 void setPackets(int[] packets) { = packets。public CounterSet(int size){ = size。 (r1, 0, r3, 0, )。} . 實(shí)例方法實(shí)例方法一般如下定義：/** * Set the packet counters * (such as when restoring from a database) */protected void setArray(int[] r1, int[] r2, int[] r3, int[] r4) throws IllegalArgumentException{ // Ensure the arrays are of equal size if ( != || != || != ) throw new IllegalArgumentException(Arrays must be of the same size)。 (r2, 0, r4, 0, )。. main方法 如果main(String[] args) 方法已經(jīng)定義了, 那么它應(yīng)該寫在類的底部 pulic static void main(String[] args) {……}. 接口接口的定義形式類似于類的定義形式。接口的聲明應(yīng)從第一列開始，“{” 應(yīng)該單獨(dú)占用一行，然后是接口體的定義，開頭要有縮進(jìn)，結(jié)束時(shí) “}” 應(yīng)該單獨(dú)占一行，且為第一列。接口字段聲明和方法聲明同類的字段和方法的聲明的形式一樣。例如：a = b + c。 // RIGHTa = b + c。 // NOT GOOD. 本地變量聲明本地變量的聲明應(yīng)在不同的行中，如果本地變量聲明后不再變動(dòng)應(yīng)當(dāng)聲明為final，使編譯器生成更有效率的代碼。 // RIGHTint i, k。 // NOT GOOD. 數(shù)組的聲明數(shù)組的[]應(yīng)該緊跟類型名，而不是數(shù)組名。例如：char buf[]。 // GOODString[] getNames() { // RIGHT, method return value. return語句return語句后面的返回值不可以用括號(hào)包起來，除非是后面所跟為一個(gè)表達(dá)式。 // WRONGr