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