2.1.2 注釋

為了使代碼易于閱讀、更加清晰易懂、便于團隊協(xié)作，通常需要在程序中為代碼添加一些注釋，對程序的某行代碼或某個功能模塊進行解釋說明。注釋只在Java源文件中有效，編譯器編譯時會忽略注釋，注釋不會被編譯到字節(jié)碼文件中去。Java有以下3種類型的注釋方式。

1.單行注釋

用來對程序中的某一行代碼進行解釋說明，使用符號//，符號后面是注釋內(nèi)容，語法格式為：//注釋內(nèi)容。單行注釋放在要解釋說明的那一行代碼的后面，注釋內(nèi)容不能太長、不能換行，太長要換行的話要用到多行注釋。代碼如下。

---

System.out.println("Hello World!!!");   //輸出字符串

---

這里在代碼行的右邊添加了注釋來說明這一行的功能。除了用于對某一行代碼進行解釋說明外，在編寫代碼過程中，如果不確定某一行代碼是否該刪除，但暫時用不上，也可以在該行代碼前面添加單行注釋符號，將它“注釋”掉，讓它暫時失去作用。若后面還用得上該行代碼，則刪除注釋符號//即可。代碼如下。

---

System.out.println("Hello World!!!");   //輸出字符串 
//System.out.println("你好 世界!!!");

---

第二行代碼被注釋掉了，將不會輸出“你好 世界！！！”。若需要重新使用該行代碼，只需刪除符號//即可。

2.多行注釋

多行注釋指注釋內(nèi)容為多行，以符號/*開頭，符號*/為結(jié)尾。語法格式為/*注釋內(nèi)容（多行）*/。除了用來解釋說明代碼功能外，多行注釋還可以一次性將暫時用不上的多行代碼“注釋”掉。代碼如下。

---

/*System.out.println("Hello World!!!");  
 System.out.println("你好 世界!!!"); */

---

這樣，這兩行代碼都暫時失去作用。如果需要恢復(fù)，刪除符號/*和*/即可。

3.文檔注釋

文檔注釋用來對類、接口、成員方法、成員變量、靜態(tài)字段、靜態(tài)方法、常量或一段代碼等進行解釋說明，以符號/**開頭，符號*/結(jié)尾，語法格式為：/**注釋內(nèi)容（多行）*/。可以使用Javadoc文檔工具提取程序中的文檔注釋，生成幫助文檔。3種注釋綜合示例代碼如下。

---

package com.seehope; 
/** 
單位：礪鋒科技 
作者：張無忌 
時間：2020-9-1 
*/ 
public class HelloWorld { 
      /* 
      第一個Java程序 
      輸出Hello World!!! 
      */ 
      public static void main(String[]args) { 
            System.out.println("Hello World!!!");//輸出英文 
            //下面輸出中文 
            System.out.println("你好 世界!!!"); 
            System.out.println("你好 中國!!!");   //輸出中文 
            //下面暫時不用的語句也可以先注釋掉       
            //System.out.println("你好 紐約!!!");                
      } 
}

---

注釋的嵌套：多行注釋可以嵌套單行注釋，但不能嵌套多行注釋。

快速注釋技巧如下。

在使用Eclipse編程過程中，常常需要把一些先前寫好的代碼暫時注釋掉， 一行行處理的話很費時，可以使用快捷方式。

方法一：先選中要注釋掉的多行代碼，然后按Ctrl+/組合鍵，這時多行代碼中的每一行代碼都會按單行注釋的方式注釋掉。代碼如下。

---

public static void main(String[]args) {             
//   System.out.println("Hello World!!!"); 
//   System.out.println("你好 世界!!!"); 
//   System.out.println("你好 中國!!!");             
}

---

若要取消這種注釋，選中已經(jīng)按這種方法注釋掉的多行代碼，然后按Ctrl+/組合鍵即可。

方法二：先選中要注釋掉的多行代碼，然后按Shift+Ctrl+/組合鍵，這時多行代碼將按多行注釋的方式注釋掉。代碼如下。

---

public static void main(String[]args) {             
/*   System.out.println("Hello World!!!"); 
     System.out.println("你好 世界!!!"); 
     System.out.println("你好 中國!!!");      */       
}

---

若要取消這種注釋，選中已經(jīng)按這種方法注釋掉的多行代碼，然后按Shift+Ctrl+\組合鍵即可。