更新時(shí)間:2021-06-28 來(lái)源:黑馬程序員 瀏覽量:
在編寫程序時(shí),為了使代碼易于閱讀,通常會(huì)在實(shí)現(xiàn)功能的同時(shí)為代碼添加一些注釋。注釋是對(duì)程序的某個(gè)功能或者某行代碼的解釋說(shuō)明,它能夠讓開(kāi)發(fā)者在后期閱讀和使用代碼時(shí)能更容易理解代碼的作用。
注釋只在Java源文件中有效,在編譯程序時(shí)編譯器會(huì)忽略這些注釋信息,不會(huì)將其編譯到class字節(jié)碼文件中。
Java中的注釋有三種類型,具體如下:
1.單行注釋
單行注釋通常用于對(duì)程序中的某一行代碼進(jìn)行解釋,用符號(hào)“//”表示,“//”后面為被注釋的內(nèi)容,具體示例如下:
int c = 10; // 定義一個(gè)整型變量c
多行注釋顧名思義就是可以同時(shí)為多行內(nèi)容進(jìn)行統(tǒng)一注釋,它以符號(hào)“/”開(kāi)頭,并以符號(hào)“/”結(jié)尾,具體示例如下:
/* 定義一個(gè)整形變量x 將5賦值給變量x */ int x; x = 5;
文檔注釋通常是對(duì)程序中某個(gè)類或類中的方法進(jìn)行的系統(tǒng)性的解釋說(shuō)明,開(kāi)發(fā)人員可以使用JDK提供的javadoc工具將文檔注釋提取出來(lái)生成一份API幫助文檔。文檔注釋以符號(hào)“/”開(kāi)頭,并以符號(hào)“/”結(jié)尾,具體示例如下:
/** * Title:HelloWorld類 * @author srx * @version 1.0 */ public class HelloWorld { /** * 這是一個(gè)main()方法入口 * @param args 參數(shù)名 */ public static void main(String[] args){ System.out.println("這是第一個(gè)Java程序!"); } }
注釋嵌套:
在Java中,有的注釋可以嵌套使用,有的則不可以,下面列舉兩種具體的情況。
1.多行注釋“/…/”中可以嵌套使用單行注釋“//”,具體示例如下:
/* int c = 10; // 定義一個(gè)整型的c int x = 5; */
2.多行注釋“/…/”中不能嵌套使用多行注釋“/…/”,具體示例如下:
/* /*int c = 10;*/ int x=5; */
上面第二種情況的代碼就無(wú)法通過(guò)編譯,原因在于第一個(gè) “/”會(huì)和第一個(gè)“/”進(jìn)行配對(duì),而第二個(gè)“*/”則找不到匹配,就會(huì)編譯失敗。
針對(duì)在使用嵌套注釋時(shí)可能出現(xiàn)編譯異常這一問(wèn)題,通常在實(shí)際開(kāi)發(fā)中都會(huì)避免對(duì)代碼注釋進(jìn)行嵌套使用,只有在特殊情況下才會(huì)在多行注釋中嵌套使用單行注釋。