This is third line. */ 編譯輸出后的 HTML 源碼則是 This is first line.
This is second line.
This is third line. 前導的 * 號答應連續使用多個,其效果和使用一個 * 號一樣,但多個 * 號前不能有其它字符分隔,否則分隔符及后面的 * 號都將作為文檔的內容。* 號在這里是作為左邊界使用,如上例的第一行和第二行;假如沒有前導的 * 號,則邊界從第一個有效字符開始,而不包括前面的空格,如上例第三行。 還有一點需要說明,文檔注釋只說明緊接其后的類、屬性或者方法。如下例: /** comment for class */ public class Test { /** comment for a attribute */ int number; /** comment for a method */ public void myMethod() { ...... } ...... } 上例中的三處注釋就是分別對類、屬性和方法的文檔注釋。它們生成的文檔分別是說明緊接其后的類、屬性、方法的?!熬o接”二字尤其重要,假如忽略了這一點,就很可能造成生成的文檔錯誤。如 import java.lang.*; /** commnet for class */ public class Test { ...... } // 此例為正確的例子 這個文檔注釋將生成正確的文檔。但只需要改變其中兩行的位置,變成下例,就會出錯: /** commnet for class */ import java.lang.*; public class Test { ...... } // 此例為錯誤的例子 這個例子只把上例的 import 語句和文檔注釋部分交換了位置,結果卻大不相同——生成的文檔中根本就找不到上述注釋的內容了。原因何在? “/** commnet for class */”是對 class Test 的說明,把它放在“public class Test { ...... }”之前時,其后緊接著 class Test,符合規則,所以生成的文檔正確。但是把它和“import java.lang.*;”調換了位置后,其后緊接的就是不 class Test 了,而是一個 import 語句。由于文檔注釋只能說明類、屬性和方法,import 語句不在此列,所以這個文檔注釋就被當作錯誤說明省略掉了。 2. 文檔注釋的三部分 根據在文檔中顯示的效果,文檔注釋分為三部分。先舉例如下,以便說明。 /** * show 方法的簡述. * <p>