2.1　代碼注釋

視頻講解：資源包\Video\02\2.1代碼注釋.mp4

在代碼中添加注釋能提高代碼的可讀性。注釋中包含了程序的信息，可以幫助程序員更好地閱讀和理解程序。在Java源程序文件的任意位置都可以添加注釋，且Java編譯器不編譯代碼中的注釋，也就是說代碼中的注釋對程序不產(chǎn)生任何影響。所以開發(fā)者不僅可以在注釋中鍵入代碼的說明文字、設計者的個人信息，還可以使用注釋來屏蔽某些不希望執(zhí)行的代碼。Java提供了3種代碼注釋，分別為單行注釋、多行注釋和文檔注釋，這些注釋在Eclipse中的效果如圖2.1所示。

1.單行注釋

//為單行注釋標記，從符號//開始直到換行為止的所有內(nèi)容均作為注釋而被編譯器忽略。語法如下：

例如，以下代碼為聲明int型變量添加注釋：

2.多行注釋

/**/為多行注釋標記，符號/*與*/之間的所有內(nèi)容均為注釋內(nèi)容。注釋中的內(nèi)容可以換行。語法如下：

3.文檔注釋

/**…*/為文檔注釋標記。符號/**與*/之間的內(nèi)容均為文檔注釋內(nèi)容。當文檔注釋出現(xiàn)在聲明（如類的聲明、類的成員變量聲明、類的成員方法聲明等）之前時，會被Javadoc文檔工具讀取作為Javadoc文檔內(nèi)容。對于讀者而言，文檔注釋并不是很重要，了解即可。

說明

一定要養(yǎng)成良好的編碼習慣。軟件編碼規(guī)范中提到“可讀性第一，效率第二”，所以程序員必須要在程序中添加適量的注釋來提高程序的可讀性和可維護性。建議程序中的注釋總量要占程序代碼總量的20%～50%。