Javadoc 注釋規(guī)范

• 1. 注釋分類
• 2. Java文檔和Javadoc
• 3. 文檔注釋的格式?
  
  • 3.1 文檔和文檔注釋的格式化
  • 3.2 文檔注釋的三部分
• 4. 使用Javadoc標(biāo)記?
  
  • 4.1 @see 的使用
  • 4.2 @author、@version 說明類
  • 4.3 @param、@return 和 @exception 的使用
• 5. Javadoc命令
• 6. 注釋范例

---

1.注釋分類

對于Java注釋共有三種分類：
1. // 注釋單行?
2. /* — */ 注釋若干行?
3. /* —?/?注釋若干行，并寫入Javadoc文檔中*?

2. Java文檔和Javadoc

? ? ? ?Java 程序員都應(yīng)該知道使用 JDK 開發(fā)，最好的幫助信息就來自 SUN 發(fā)布的 Java 文檔。它分包、分類詳細的提供了各方法、屬性的幫助信息，具有詳細的類樹信息、索引信息等，并提供了許多相關(guān)類之間的關(guān)系，如繼承、實現(xiàn)接口、引用等。

　　Java 文檔全是由一些 html 文件組織起來的，在 SUM 的站點上可以下載它們的壓縮包。但是你肯定想不到，這些文檔我們可以自己生成。

　　安裝了 JDK 之后，安裝目錄下有一個 src.jar 文件或者 src.zip 文件，它們都是以 ZIP 格式壓縮的，可以使用 WinZip 解壓。解壓之后，我們就可以看到分目錄放的全是 .java 文件。是了，這些就是 Java 運行類的源碼了，非常完整，連注釋都寫得一清二楚

　　仔細對比一下 .java 源文件中的文檔注釋 (/* …?/) 和 Java 文檔的內(nèi)容，你會發(fā)現(xiàn)它們就是一樣的。再仔細一點，你會發(fā)現(xiàn) .java 源文件中的注釋還帶有 HTML 標(biāo)識，如 ＜B＞、＜BR＞、＜Code＞ 等，在 Java 文檔中該出現(xiàn)這些標(biāo)識的地方，已經(jīng)按標(biāo)識的的定義進行了排版。

　　在 JDK 的 bin 目錄下你可以找到 javadoc，如果是 Windows 下的 JDK，它的文件名為 javadoc.exe。使用 javdoc 編譯 .java 源文件時，它會讀出 .java 源文件中的文檔注釋，并按照一定的規(guī)則與 Java 源程序一起進行編譯，生成文檔。

　　為了能夠編譯下面提到的若干例子，這里先介紹一條 javadoc 命令：javadoc -d 文檔存放目錄 -author -version 源文件名.java這條命令編譯一個名為 “源文件名.java”的 java 源文件，并將生成的文檔存放在“文檔存放目錄”指定的目錄下，生成的文檔中 index.html 就是文檔的首頁。-author 和 -version 兩上選項可選。?

3. 文檔注釋的格式

? ? ? ?文檔注釋可以用于對類、屬性、方法等進行說明。寫文檔注釋時除了需要使用 /* ….?/ 限定之外，還需要注意注釋內(nèi)部的一些細節(jié)問題。?

3.1 文檔和文檔注釋的格式化

? ? ? ?生成的文檔是HTML格式，而這些HTM 格式的標(biāo)識符并不是Javadoc加的，而是我們在寫注釋的時候?qū)懮先サ摹１热?#xff0c;需要換行時，不是敲入一個回車符，而是寫入＜br＞，如果要分段，就應(yīng)該在段前寫入 ＜p＞。

　　因此，格式化文檔，就是在文檔注釋中添加相應(yīng)的 HTML 標(biāo)識。

　　文檔注釋的正文并不是直接復(fù)制到輸出文件 (文檔的 HTML 文件)，而是讀取每一行后，刪掉前導(dǎo)的 * 號及 * 號以前的空格，再輸入到文檔的。如：?
? ? ? ?/**?
? ? ? ? * This is first line. ＜br＞?
? ? ? ??*?This is second line. ＜br＞?
? ? ? ?This is third line.?
? ? ? ?*/

　　編譯輸出后的HTML源碼則是：?
? ? ? ?This is first line. ＜br＞?
? ? ? ?This is second line. ＜br＞?
? ? ? ?This is third line.

　　前導(dǎo)的 * 號允許連續(xù)使用多個，其效果和使用一個 * 號一樣，但多個 * 號前不能有其它字符分隔，否則分隔符及后面的 * 號都將作為文檔的內(nèi)容。

　　還有一點需要說明，文檔注釋只說明緊接其后的類、屬性或者方法。如下例：?
? ? ? ?/* comment for class?/?
? ? ? ?public class Test {

? ? ? ?/* comment for a attribute?/?
? ? ? ?int number;

? ? ? ?/* comment for a method?/?
? ? ? ?public void myMethod() {?
? ? ? ?? ? ? ?……?
? ? ? ?}?
? ? ? ?……?
? ? ? ?}

　　上例中的三處注釋就是分別對類、屬性和方法的文檔注釋。它們生成的文檔分別是說明緊接其后的類、屬性、方法的。“緊接”二字尤其重要，如果忽略了這一點，就很可能造成生成的文檔錯誤。如：?
? ? ? ?import java.lang.*;

? ? ? ?/* commnet for class?/?
? ? ? ?public class Test { …… }

? ? ? ?// 此例為正確的例子

　　這個文檔注釋將生成正確的文檔。但只需要改變其中兩行的位置，變成下例，就會出錯：?
? ? ? ?/* commnet for class?/

? ? ? ?import java.lang.*;

? ? ? ?public class Test { …… }

? ? ? ?// 此例為錯誤的例子

　　這個例子只把上例的 import 語句和文檔注釋部分交換了位置，結(jié)果卻大不相同——生成的文檔中根本就找不到上述注釋的內(nèi)容了。

　　/* commnet for class?/是對 class Test 的說明，把它放在public class Test { …… }之前時，其后緊接著 class Test，符合規(guī)則，所以生成的文檔正確。但是把它和“import java.lang.*;調(diào)換了位置后，其后緊接的就是不 class Test 了，而是一個 import 語句。由于文檔注釋只能說明類、屬性和方法，import 語句不在此列，所以這個文檔注釋就被當(dāng)作錯誤說明省略掉了。?

3.2 文檔注釋的三部分

　　根據(jù)在文檔中顯示的效果，文檔注釋分為三部分。先舉例如下，以便說明。　　

? ? ? ?? ?/** 　
　　　* show 方法的簡述.　　
　　　* ＜p＞show 方法的詳細說明第一行＜br＞　　
　　　* show 方法的詳細說明第二行　　
　　　* @param b true 表示顯示，false 表示隱藏　　
　　　* @return 沒有返回值　　
　　　*/　　
　　public void show(boolean b) {　　
　　　　frame.show(b);　　
　　}

　　第一部分是簡述，列表中屬性名或者方法名后面那段說明就是簡述。簡述部分寫在一段文檔注釋的最前面，第一個點號 (.) 之前 (包括點號)。換句話說，就是用第一個點號分隔文檔注釋，之前是簡述，之后是第二部分和第三部分。如上例中的 “* show 方法的簡述.”。

　　有時，即使正確地以一個點號作為分隔，javadoc 仍然會出錯，把點號后面的部分也做為了第一部分。為了解決這個問題，我們可以使用一個 ＜p＞ 標(biāo)志將第二分部分分開，如上例的“* ＜p＞show 方法的詳細說明第一行 ….”。　　

　　第二部分是詳細說明部分。該部分對屬性或者方法進行詳細的說明，在格式上沒有什么特殊的要求，可以包含若干個點號。　　

　　第三部分是特殊說明部分。這部分包括版本說明、參數(shù)說明、返回值說明等。第三部分在上例中相應(yīng)的代碼是：?
　　* @param b true 表示顯示，false 表示隱藏 　
　　* @return 沒有返回值?
　　除了 @param 和 @return 之外，還有其它的一些特殊標(biāo)記，分別用于對類、屬性和方法的說明。?

4. 使用Javadoc標(biāo)記

? ? ? ?Javadoc標(biāo)記是插入文檔注釋中的特殊標(biāo)記，它們用于標(biāo)識代碼中的特殊引用。javadoc 標(biāo)記由“@”及其后所跟的標(biāo)記類型和專用注釋引用組成。記住了，三個部分——@、標(biāo)記類型、專用注釋引用。雖然 @ 和 標(biāo)記類型之間有時可以用空格符分隔，但是推薦將它們緊挨著寫，以減少出錯機會。

? ? ? ?javadoc 標(biāo)記有如下一些：

?

4.1 @see 的使用

? ? ? ?@see 的句法有三種：?
? ? ? ?1. @see 類名?
? ? ? ?2. @see #方法名或?qū)傩悦?
? ? ? ?3. @see 類名#方法名或?qū)傩悦?/p>

? ? ? ?類名，可以根據(jù)需要只寫出類名 (如 String) 或者寫出類全名 (如 java.lang.String)。那么什么時候只需要寫出類名，什么時候需要寫出類全名呢？

? ? ? ?如果 java 源文件中的 import 語句包含了的類，可以只寫出類名，如果沒有包含，則需要寫出類全名。java.lang 也已經(jīng)默認被包含了。這和 javac 編譯 java 源文件時的規(guī)定一樣，所以可以簡單的用 javac 編譯來判斷，源程序中 javac 能找到的類，javadoc 也一定能找到；javac 找不到的類，javadoc 也找不到，這就需要使用類全名了。

? ? ? ?方法名或者屬性名，如果是屬性名，則只需要寫出屬性名即可；如果是方法名，則需要寫出方法名以及參數(shù)類型，沒有參數(shù)的方法，需要寫出一對括號。如

? ? ? ?有時也可以偷懶：假如上例中，沒有 count 這一屬性，那么參考方法 count() 就可以簡寫成 @see count。不過，為了安全起見，還是寫全 @see count() 比較好。?
? ? ? ?@see 的第二個句法和第三個句法都是轉(zhuǎn)向方法或者屬性的參考，它們有什么區(qū)別呢？?
? ? ? ?第二個句法中沒有指出類名，則默認為當(dāng)前類。所以它定義的參考，都轉(zhuǎn)向本類中的屬性或者方法。而第三個句法中指出了類名，則還可以轉(zhuǎn)向其它類的屬性或者方法。?
? ? ? ?關(guān)于 @see 標(biāo)記，我們舉個例說明。由于 @see 在對類說明、對屬性說明、對方法說明時用法都一樣，所以這里只以對類說明為例。?
/**?
* @see java.lang.String?
* @see #str?
* @see #str()?
* @see #main(String[])?
* @see java.lang.Object#toString()?
*/?
public class TestJavaDoc?
{?
? ? ? ?private String str;?
? ? ? ?public void str(){?
? ? ? ?}?
? ? ? ?public static void main(String[] args){?
? ? ? ?}?
}?
? ? ? ?生成的文檔的相關(guān)部分如下圖：

? ? ? ?String這個類可以直接寫類名，也可以寫類全名。str、str() 為同名屬性和方法，所以方法名需要用 () 區(qū)分。main 是帶參數(shù)的方法，所以在 () 中指明了參數(shù)類型。toString() 雖然在本類中也有 (從 Object 繼承的)，但我們是想?yún)⒖?Object 類的 toString() 方法，所以使用了 Object#toString()。?
? ? ? ?為什么其中只有 str、str() 和 main(String[]) 變成了鏈接呢？那是因為編譯時沒有把 java.lang 包一起加入編譯，所以，生成的文檔沒有關(guān)于那三個類的信息，也就不可以建立鏈接了。后面講解 javadoc 編譯命令的時候還會詳細說明。?

4.2 @author、@version 說明類

? ? ? ?這兩個標(biāo)記分別用于指明類的作者和版本。缺省情況下 javadoc 將其忽略，但命令行開關(guān) -author 和 -version 可以修改這個功能，使其包含的信息被輸出。這兩個標(biāo)記的句法如下：?
　　@author 作者名?
　　@version 版本號?
　　其中，@author 可以多次使用，以指明多個作者，生成的文檔中每個作者之間使用逗號 (,) 隔開。@version 也可以使用多次，只有第一次有效，生成的文檔中只會顯示第一次使用 @version 指明的版本號。如下例?
/**?
* @author Fancy?
* @author Bird?
* @version Version 1.00?
* @version Version 2.00?
*/?
public class TestJavaDoc {?
}?
生成文檔的相關(guān)部分如圖：?

? ? ? ?從圖上看，作者列表是以逗號分隔的，如果我想分行顯示怎么辦？另外，如果我想顯示兩個以上的版本號又該怎么辦？我們可以將上述兩條 @author 語句合為一句，把兩個 @version 語句也合為一句：?
@author Fancy＜br＞Bird?
@version Version 1.00＜br＞Version 2.00?
結(jié)果如圖：?

? ? ? ?我們這樣做即達到了目的，又沒有破壞規(guī)則。@author 之后的作者名和 @version 之后的版本號都可以是用戶自己定義的任何 HTML 格式，所以我們可以使用 ＜br＞ 標(biāo)記將其分行顯示。?

4.3 @param、@return 和 @exception 的使用

這三個標(biāo)記都是只用于方法的。@param 描述方法的參數(shù)，@return 描述方法的返回值，@exception 描述方法可能拋出的異常。它們的句法如下：?
? ? ? ?@param 參數(shù)名 參數(shù)說明?
? ? ? ?@return 返回值說明?
? ? ? ?@exception 異常類名 說明?
每一個 @param 只能描述方法的一個參數(shù)，所以，如果方法需要多個參數(shù)，就需要多次使用 @param 來描述。?
一個方法中只能用一個 @return，如果文檔說明中列了多個 @return，則 javadoc 編譯時會發(fā)出警告，且只有第一個 @return 在生成的文檔中有效。?
? ? ? ?方法可能拋出的異常應(yīng)當(dāng)用 @exception 描述。由于一個方法可能拋出多個異常，所以可以有多個 @exception。每個 @exception 后面應(yīng)有簡述的異常類名，說明中應(yīng)指出拋出異常的原因。需要注意的是，異常類名應(yīng)該根據(jù)源文件的 import 語句確定是寫出類名還是類全名。示例如下：?
public class TestJavaDoc {?
/**?
* @param n a switch?
* @param b excrescent parameter?
* @return true or false?
* @return excrescent return?
* @exception java.lang.Exception throw when switch is 1?
* @exception NullPointerException throw when parameter n is null?
*/?
public boolean fun(Integer n) throws Exception {?
? ? ? ?switch (n.intValue()) {?
? ? ? ?case 0:?
? ? ? ?? ? ? ?break;?
? ? ? ?case 1:?
? ? ? ?? ? ? ?throw new Exception(“Test Only”);?
? ? ? ?default:?
? ? ? ?? ? ? ?return false;?
? ? ? ? }?
? ? ? ?return true;?
}?
使用 javadoc 編譯生成的文檔相關(guān)部分如下圖：?

? ? ? ?可以看到，上例中 @param b excrescent parameter 一句是多余的，因為參數(shù)只是一個 n，并沒有一個 b。但是 javadoc 編譯時并沒有檢查。因此，寫文檔注釋時一定要正確匹配參數(shù)表與方法中正式參數(shù)表的項目。如果方法參數(shù)表中的參數(shù)是 a，文檔中卻給出對參數(shù) x 的解釋，或者再多出一個參數(shù) i，就會讓人摸不著頭腦了。@exceptin 也是一樣。?
? ? ? ?上例程序中并沒有拋出一個 NullPointerException，但是文檔注釋中為什么要寫上這么一句呢，難道又是為了演示？這不是為了演示描述多余的異常也能通過編譯，而是為了說明寫異常說明時應(yīng)考運行時 (RunTime) 異常的可能性。上例程序中，如果參數(shù) n 是空值 (null)，那么程序會在運行的時候拋出一個 NullPointerException，因此，在文檔注釋中添加了對 NullPointerException 的說明。?
? ? ? ?上例中的 @return 語句有兩個，但是根據(jù)規(guī)則，同一個方法中，只有第一個 @return 有效，其余的會被 javadoc 忽略。所以生成的文檔中沒有出現(xiàn)第二個 @return 的描述。?

5. Javadoc命令

? ? ? ?運行： javadoc -help 可以看到 javadoc 的用法，這里列舉常用參數(shù)如下：?
? ? ? ?用法：javadoc [options] [packagenames] [sourcefiles]?
? ? ? ?選項：

? ? ? ?? ? ? ?-public 僅顯示 public 類和成員?
? ? ? ?? ? ? ?-protected 顯示 protected/public 類和成員 (缺省)?
? ? ? ?? ? ? ?-package 顯示 package/protected/public 類和成員?
? ? ? ?? ? ? ?-private 顯示所有類和成員?
? ? ? ?? ? ? ?-d ＜directory＞ 輸出文件的目標(biāo)目錄?
? ? ? ?? ? ? ?-version 包含 @version 段?
? ? ? ?? ? ? ?-author 包含 @author 段?
? ? ? ?? ? ? ?-splitindex 將索引分為每個字母對應(yīng)一? ? ? ?個文件?
? ? ? ?? ? ? ?-windowtitle ＜text＞ 文檔的瀏覽器窗口標(biāo)題

? ? ? ?javadoc 編譯文檔時可以給定包列表，也可以給出源程序文件列表。例如在 CLASSPATH 下有兩個包若干類如下：?
　　fancy.Editor?
　　fancy.Test?
　　fancy.editor.ECommand?
　　fancy.editor.EDocument?
　　fancy.editor.EView?
? ? ? ?這里有兩個包 (fancy 和 fancy.editor) 和 5 個類。那么編譯時 (Windows 環(huán)境) 可以使用如下 javadoc 命令：

? ? ? ?javadoc fancy\Test.Java?fancy Editor.java fancy\editor\ECommand.java fancy\editor\EDocument.java fancy\editor\EView.java

? ? ? ?這是給出 java 源文件作為編譯參數(shù)的方法，注意命令中指出的是文件路徑，應(yīng)該根據(jù)實際情況改變。也可以是給出包名作為編譯參數(shù)，如：

? ? ? ?javadoc fancy fancy.editor

? ? ? ?用瀏覽器打開生成文檔的 index.html 文件即可發(fā)現(xiàn)兩種方式編譯結(jié)果的不同，如下圖：?

? ? ? ?用第二條命令生成的文檔被框架分成了三部分：包列表、類列表和類說明。在包列表中選擇了某個包之后，類列表中就會列出該包中的所有類；在類列表中選擇了某個類之后，類說明部分就會顯示出該類的詳細文檔。?
? ? ? ?下面再來細說選項。?
? ? ? ?-public、-protected、-package、-private 四個選項，只需要任選其一即可。它們指定的顯示類成員的程度。它們顯示的成員多少是一個包含的關(guān)系，如下：

? ? ? ?-private (顯示所有類和成員)?
? ? ? ?-package (顯示 package/protected/public 類和成員)?
? ? ? ?-protected (顯示 protected/public 類和成員)?
? ? ? ?-public (僅顯示 public 類和成員)

? ? ? ?-d 選項允許你定義輸出目錄。如果不用 -d 定義輸出目錄，生成的文檔文件會放在當(dāng)前目錄下。-d 選項的用法是

? ? ? ?-d 目錄名

? ? ? ?目錄名為必填項，也就是說，如果你使用了 -d 參數(shù)，就一定要為它指定一個目錄。這個目錄必須已經(jīng)存在了，如果還不存在，請在運行 javadoc 之前創(chuàng)建該目錄。?
? ? ? ?-version 和 -author 用于控制生成文檔時是否生成 @version 和 @author 指定的內(nèi)容。不加這兩個參數(shù)的情況下，生成的文檔中不包含版本和作者信息。?
? ? ? ?-splitindex 選項將索引分為每個字母對應(yīng)一個文件。默認情況下，索引文件只有一個，且該文件中包含所有索引內(nèi)容。當(dāng)然生成文檔內(nèi)容不多的時候，這樣做非常合適，但是，如果文檔內(nèi)容非常多的時候，這個索引文件將包含非常多的內(nèi)容，顯得過于龐大。使用 -splitindex 會把索引文件按各索引項的第一個字母進行分類，每個字母對應(yīng)一個文件。這樣，就減輕了一個索引文件的負擔(dān)。?
? ? ? ?-windowtitle 選項為文檔指定一個標(biāo)題，該標(biāo)題會顯示在窗口的標(biāo)題欄上。如果不指定該標(biāo)題，而默認的文檔標(biāo)題為“生成的文檔（無標(biāo)題）”。該選項的用法是：

? ? ? ?-windowtitle 標(biāo)題

? ? ? ?標(biāo)題是一串沒有包含空格的文本，因為空格符是用于分隔各參數(shù)的，所以不能包含空格。同 -d 類似，如果指定了 -windowtitle 選項，則必須指定標(biāo)題文本。

6. 注釋范例

參考Java官方

? ? ? ?代碼注釋是架起程序設(shè)計者與程序閱讀者之間的通信橋梁，最大限度的提高團隊開發(fā)合作效率。也是程序代碼可維護性的重要環(huán)節(jié)之一。?


原則：?
? ? ? ?1.?注釋形式統(tǒng)一?
? ? ? ?? 在整個應(yīng)用程序中，使用具有一致的標(biāo)點和結(jié)構(gòu)的樣式來構(gòu)造注釋。如果在其它項目中發(fā)現(xiàn)它們的注釋規(guī)范與這份文檔不同，按照這份規(guī)范寫代碼，不要試圖在既成的規(guī)范系統(tǒng)中引入新的規(guī)范。?
? ? ? ?1.?注釋內(nèi)容準(zhǔn)確簡潔?
? ? ? ?? 內(nèi)容要簡單、明了、含義準(zhǔn)確，防止注釋的多義性，錯誤的注釋不但無益反而有害。?


注釋條件?
1. 基本注釋（必須加）?
? ? ? ?(a)類（接口）的注釋?
? ? ? ?(b)構(gòu)造函數(shù)的注釋?
? ? ? ?(c)方法的注釋?
? ? ? ?(d)全局變量的注釋?
? ? ? ?(e)字段/屬性的注釋?
? ?備注：簡單的代碼做簡單注釋，注釋內(nèi)容不大于10個字即可，另外，持久化對象或VO對象的getter、setter方法不需加注釋。具體的注釋格式請參考下面舉例。?
2. 特殊必須加注釋（必須加）?
? ? ? ? (a)典型算法?必須有注釋。?
? ? ? ? (b)在代碼不明晰處必須有注釋。?
? ? ? ? (c)在代碼修改處加上修改標(biāo)識的注釋。?
? ? ? ? (d)在循環(huán)和邏輯分支組成的代碼中加注釋。?
? ? ? ? (e)為他人提供的接口必須加詳細注釋。?
? ?備注：此類注釋格式暫無舉例。具體的注釋格式自行定義，要求注釋內(nèi)容準(zhǔn)確簡潔。?


注釋格式?
? ? ? ?1、單行(single-line)注釋：“//……”

? ? ? ?2、塊(block)注釋：“/……/”

? ? ? ?3、文檔注釋：“/*……/”

? ? ? ?4、javadoc 注釋標(biāo)簽語法

? ? ? ?? ? @author 對類的說明 標(biāo)明開發(fā)該類模塊的作者

? ? ? ?? ? @version 對類的說明 標(biāo)明該類模塊的版本

? ? ? ?? ? @see 對類、屬性、方法的說明參考轉(zhuǎn)向，也就是相關(guān)主題

? ? ? ?? ? @param 對方法的說明 對方法中某參數(shù)的說明

? ? ? ?? ? @return 對方法的說明 對方法返回值的說明

? ? ? ?? ? @exception 對方法的說明 對方法可能拋出的異常進行說明

注釋范例?
1.?類（接口）注釋?

例如：

/**?
　* Class description goes here.?
　* @ClassName：Test?
　* @author Administrator?
　* @date 2016/6/29?
　*?
　*/

public class Test extends Button {

……

}?
2.?構(gòu)造方法注釋?

例如:

public class Test extends Button {　　
　/**?
　* Constructor description goes here.?
　* @param name?
　* The more description.?
　*?
　*/
　public Test(String name){

　　　……

　}

}?
3.?方法注釋?

例如

public class Test extends Button {?
/**?
　* Fuction description goes here.?
　* @param color?
　* @return void?
　* @exception (If needed)?
　* @author Administrator?
　* @date 2016/6/29?
　*?
　*/?
public voidaddColor(String color){

……

}

}?
4.?全局變量注釋?

例如：

public final class String

implements Java.io.Serializable, Comparable,CharSequence

{

　　/* The value is used for characterstorage.?/?
　　private final char value[];

　　/* The offset is the first index of thestorage that is used.?/?
　　private final int offset;

　　/* The count is the number of charactersin the String.?/?
　　private final int count;

　　/* Cache the hash code for the string?/?
　　private int hash; // Default to 0

　　……

}?
5.?字段/屬性注釋

/* classVar1 documentation comment?/?
public static int classVar1;

/** classVar2 documentation comment that happens to be?
*? ? more than one line long?
*/?
private static Object classVar2;

/* instanceVar1 documentation comment?/?
public Object instanceVar1;

/* instanceVar2 documentation comment?/?
protected int instanceVar2;

/* instanceVar3 documentation comment?/?
private Object[] instanceVar3;?


6.?文件注釋

/*?
* @(#)Blah.java 　　1.82 99/03/18?
*?
* Copyright (c) 1994-1999 Sun Microsystems, Inc.?
901 San Antonio 　* Road, Palo Alto, California, 94303, U.S.A.All rights reserved.?
*

* This software is the confidential and proprietary information of Sun?
* Microsystems, Inc. (“Confidential Information”). You shall not?
* disclose such Confidential Information and shall use it only in?
* accordance with the terms of the license agreement you entered into?
* with Sun.?
*/

package java.blah;

import java.blah.blahdy.BlahBlah;

/**?
* Class description goes here.?
* @version 1.82 18 Mar 1999?
* @author Firstname Lastname?
*?
*/?
public class Blah extends SomeClass {?
　　…?
}

from:?http://blog.csdn.net/ice_bin123/article/details/51792323

總結(jié)

以上是生活随笔為你收集整理的详细聊聊Javadoc注释规范的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。