【正文】 ok() { }}. 空格下列情況建議使用單個(gè)空格（not tab）:在一個(gè)關(guān)鍵字和它所修飾的塊之間?？捎糜谌缦碌年P(guān)鍵字：catch，for，if，switch，synchronized，while 。下列關(guān)鍵字的后面請(qǐng)不要跟隨空格：super ，this 。在任何關(guān)鍵字和它所用的參數(shù)之間。例如：return true ；在一個(gè)列表中逗號(hào)之后。例如 foo(long_expression1, long_expression2, long_expression3)。//RIGHT foo(long_expression1,long_expression2,long_expression3)。//NOT GOOD下列情況不建議使用空格左括號(hào)和后一個(gè)字符之間不應(yīng)該出現(xiàn)空格，例如：if (i== 42)；//RIGHTif( i==42)。 //NOT GOOD右括號(hào)和前一個(gè)字符之間也不應(yīng)該出現(xiàn)空格，例如：if (i== 42)；//RIGHTif(i==42 )。 //NOT GOOD. 縮進(jìn)行的縮進(jìn)要求是四個(gè)空格。由于在使用不同的源代碼管理工具時(shí)Tab字符將因?yàn)橛脩粼O(shè)置的不同而擴(kuò)展為不同的寬度，所以請(qǐng)不要使用tab鍵。建議修改各管理工具的設(shè)置將Tab字符擴(kuò)展成4個(gè)空格。. 行的延續(xù)代碼中的行應(yīng)該為80列，源代碼一般不會(huì)超過(guò)這個(gè)寬度, 如超過(guò)了80列應(yīng)該截成較短的行，建議超長(zhǎng)的語(yǔ)句應(yīng)該在一個(gè)逗號(hào)或者一個(gè)操作符后折行。一條語(yǔ)句換行后, 應(yīng)該比原來(lái)的語(yǔ)句有所縮進(jìn)，縮進(jìn)的具體格數(shù)要依據(jù)該語(yǔ)句的類(lèi)型。例如：// 好的折行方式foo(long_expression1, long_expression2, long_expression3)。//縮進(jìn)后與上一行l(wèi)ong_expression1對(duì)齊// 好的折行方式foo(long_expression1, long_expression2,// 縮進(jìn)后與上一行l(wèi)ong_expression1對(duì)齊 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。}while (long_logical_test_1 || long_logical_test2 || long_expression3){}. 注釋l 一般來(lái)說(shuō)，注釋的使用應(yīng)按照以下原則：l 注釋?xiě)?yīng)該能夠幫助讀者理解代碼的功能和作用，應(yīng)該有助于讀者理解程序的流程。l 注釋要言簡(jiǎn)意賅。l 錯(cuò)誤的注釋還不如不做注釋。l 臨時(shí)的注釋用“temporary note”進(jìn)行標(biāo)注，以利于將來(lái)程序發(fā)布時(shí)將其刪去。例如：// temporary note: Change this to call sort() when the bugs in it are fixed listmySort()。 l 對(duì)于廣大的開(kāi)發(fā)人員只要在源碼的編寫(xiě)過(guò)程中注意加入適當(dāng)?shù)淖⑨專(zhuān)瑒t與源碼同步的文檔也就隨之產(chǎn)生。以下將詳細(xì)介紹注釋的編寫(xiě)規(guī)范：. 版權(quán)信息注釋版權(quán)信息必須在 java 文件的開(kāi)頭，比如：/** * pCopyright 174。 2002 金質(zhì)工程版權(quán)所有。/p */ . 類(lèi)注釋類(lèi)注釋通常放在類(lèi)定義的前面（類(lèi)實(shí)體以外）。通常詳細(xì)介紹該類(lèi)的功能，作者，版本，“@deprecated標(biāo)志”的使用，以及產(chǎn)生該類(lèi)的時(shí)間和引用其他類(lèi)等信息。如下：/** * 類(lèi)功能介紹。 * * pcodeMethod/code 介紹信息可以使用 HTML 標(biāo)記。 * * @see * @see getDeclaredMethod(String, Class[]) * @author Frank * @version , 20011218 * @author Mary * @deprecated */解釋?zhuān)篅see：引用其他類(lèi)所有三種類(lèi)型的注釋文檔都可包含@see標(biāo)記，它允許我們引用其他類(lèi)里的文檔。對(duì)于這個(gè)標(biāo)記，javadoc會(huì)生成相應(yīng)的HTML，將其直接鏈接到其他文檔。格式如下：@see 類(lèi)名 @see 完整類(lèi)名@see 完整類(lèi)名方法名每一格式都會(huì)在生成的文檔里自動(dòng)加入一個(gè)超鏈接的“See Also”（參見(jiàn)）條目。注意javadoc不會(huì)檢查我們指定的超鏈接，不會(huì)驗(yàn)證它們是否有效。@version格式如下：@version 版本信息其中，“版本信息”代表任何適合作為版本說(shuō)明的資料。若在javadoc命令行使用了“version”標(biāo)記，就會(huì)從生成的HTML文檔里提取出版本信息。@author格式如下：@author 作者信息其中，“作者信息”包括作者的姓名、電子函件地址或者其他任何適宜的資料。若在javadoc命令行使用了“author”標(biāo)記，就會(huì)專(zhuān)門(mén)從生成的HTML文檔里提取出作者信息?？蔀橐幌盗凶髡呤褂枚鄠€(gè)這樣的標(biāo)記，但它們必須連續(xù)放置。全部作者信息會(huì)一起存入最終HTML代碼的單獨(dú)一個(gè)段落里。@deprecated這是Java 。該標(biāo)記用于指出一些舊功能已由改進(jìn)過(guò)的新功能取代。該標(biāo)記的作用是建議用戶不必再使用一種特定的功能，因?yàn)槲磥?lái)改版時(shí)可能摒棄這一功能。若將一個(gè)方法標(biāo)記為@deprecated，則使用該方法時(shí)會(huì)收到編譯器的警告。. 成員注釋只有 public 和 protected 類(lèi)型的類(lèi)成員的注釋可以被 javadoc 提取到文檔中，而 private 型和“友好”（沒(méi)有限定符）的類(lèi)成員將被忽略。但是為了提高項(xiàng)目的可讀性和可維護(hù)性，建議將所有的類(lèi)成員都注釋。如下：/** * codedouble/code 型數(shù)值的最大值。 * 它等于 * blockquotepre * code(0x7fefffffffffffffL)/code * /pre/blockquote * 的返回值。 */ public static final double MAX_VALUE = +308。. 方法注釋方法注釋的注意內(nèi)容有方法功能介紹，參數(shù)說(shuō)明，返回類(lèi)型說(shuō)明，例外類(lèi)型，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 */解釋?zhuān)篅param格式如下：@param 參數(shù)名 說(shuō)明其中，“參數(shù)名”是指參數(shù)列表內(nèi)的標(biāo)識(shí)符，而“說(shuō)明”代表一些可延續(xù)到后續(xù)行內(nèi)的說(shuō)明文字。一旦遇到一個(gè)新文檔標(biāo)記，就認(rèn)為前一個(gè)說(shuō)明結(jié)束?？墒褂萌我鈹?shù)量的說(shuō)明，每個(gè)參數(shù)一個(gè)。@return格式如下：@return 說(shuō)明其中，“說(shuō)明”是指返回值的含義。它可延續(xù)到后面的行內(nèi)。@exception當(dāng)方法中發(fā)生異常時(shí)，“扔出”對(duì)象。調(diào)用一個(gè)方法時(shí)，盡管只有一個(gè)違例對(duì)象出現(xiàn)，但一些特殊的方法也許能產(chǎn)生任意數(shù)量的、不同類(lèi)型的違例。所有這些違例都需要說(shuō)明。所以，違例標(biāo)記的格式如下：@exception 完整類(lèi)名 說(shuō)明其中，“完整類(lèi)名”明確指定了一個(gè)違例類(lèi)的名字，它是在其他某個(gè)地方定義好的。而“說(shuō)明”（同樣可以延續(xù)到下面的行）告訴我們?yōu)槭裁催@種特殊類(lèi)型的違例會(huì)在方法調(diào)用中出現(xiàn)。@since格式如下：@since 說(shuō)明利用說(shuō)明內(nèi)容為文檔增加since標(biāo)題，表示從何時(shí)開(kāi)始使用該方法或者類(lèi)(以正式發(fā)布的版本為準(zhǔn))@see