為什么要給代碼添加注釋？Java中的注釋有幾種

在編寫程序時，為了使代碼易于閱讀，通常會在實現(xiàn)功能的同時為代碼添加一些注釋。注釋是對程序的某個功能或者某行代碼的解釋說明，它能夠讓開發(fā)者在后期閱讀和使用代碼時能更容易理解代碼的作用。

注釋只在Java源文件中有效，在編譯程序時編譯器會忽略這些注釋信息，不會將其編譯到class字節(jié)碼文件中。

Java中的注釋有三種類型，具體如下：

1．單行注釋

單行注釋通常用于對程序中的某一行代碼進(jìn)行解釋，用符號“//”表示，“//”后面為被注釋的內(nèi)容，具體示例如下：

int c = 10;      // 定義一個整型變量c

多行注釋顧名思義就是可以同時為多行內(nèi)容進(jìn)行統(tǒng)一注釋，它以符號“/”開頭，并以符號“/”結(jié)尾，具體示例如下：

/* 定義一個整形變量x
將5賦值給變量x */
int x;
x = 5;

文檔注釋通常是對程序中某個類或類中的方法進(jìn)行的系統(tǒng)性的解釋說明，開發(fā)人員可以使用JDK提供的javadoc工具將文檔注釋提取出來生成一份API幫助文檔。文檔注釋以符號“/”開頭，并以符號“/”結(jié)尾，具體示例如下：

/**
 * Title：HelloWorld類
 * @author srx
 * @version 1.0    
 */
public class HelloWorld {
    /**
     * 這是一個main()方法入口
     * @param args 參數(shù)名
     */
    public static void main(String[] args){
        System.out.println("這是第一個Java程序！");
    }
}

注釋嵌套：

在Java中，有的注釋可以嵌套使用，有的則不可以，下面列舉兩種具體的情況。

1．多行注釋“/…/”中可以嵌套使用單行注釋“//”，具體示例如下：

/* int c = 10;  // 定義一個整型的c
  int x = 5; */

2．多行注釋“/…/”中不能嵌套使用多行注釋“/…/”，具體示例如下：

/*
  /*int c = 10;*/
  int x=5;
*/

上面第二種情況的代碼就無法通過編譯，原因在于第一個 “/”會和第一個“/”進(jìn)行配對，而第二個“*/”則找不到匹配，就會編譯失敗。

針對在使用嵌套注釋時可能出現(xiàn)編譯異常這一問題，通常在實際開發(fā)中都會避免對代碼注釋進(jìn)行嵌套使用，只有在特殊情況下才會在多行注釋中嵌套使用單行注釋。

Java中有多少個關(guān)鍵字?使用關(guān)鍵字應(yīng)當(dāng)注意什么

volatile關(guān)鍵字的作用，看完你明白了！

Java語言中的標(biāo)識符規(guī)則有哪些

傳智教育Java開發(fā)培訓(xùn)