2.1.2 Java中的注釋

在Java程序中，為了使代碼便于閱讀和修改，會(huì)在實(shí)現(xiàn)代碼的同時(shí)為其添加一些注釋?zhuān)脕?lái)對(duì)相應(yīng)的代碼功能進(jìn)行解釋?zhuān)@些注釋也能讓后續(xù)的開(kāi)發(fā)者更加容易理解代碼、維護(hù)程序。注釋并不會(huì)影響代碼的執(zhí)行，編譯器會(huì)自動(dòng)忽略源碼中的注釋?zhuān)粫?huì)將其放到編譯出的class字節(jié)碼文件中。

為方便使用，Java中提供了3類(lèi)注釋方式，分別服務(wù)不同的解釋需要。

1.單行注釋

通常用于對(duì)程序中某行代碼進(jìn)行解釋?zhuān)梅?hào)“//”置于代碼行尾，“//”后面的內(nèi)容為解釋的內(nèi)容，適用于簡(jiǎn)短說(shuō)明。例如，

2.多行注釋

可以同時(shí)對(duì)一行或多行代碼進(jìn)行統(tǒng)一注釋?zhuān)苑?hào)“/*”開(kāi)頭，以符號(hào)“*/”結(jié)尾，中間的內(nèi)容為解釋的內(nèi)容。

3.文檔注釋

通常是對(duì)程序代碼進(jìn)行的系統(tǒng)性解釋說(shuō)明，以符號(hào)“/**”開(kāi)頭，以符號(hào)“*/”結(jié)尾，表示位于開(kāi)頭結(jié)尾之間的文本，可以用javadoc命令抽取文檔注釋并生成于相應(yīng)的HTML文檔之中。例如，在定義類(lèi)的代碼中我們可以加入以下注釋。