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