2.1.4　Java注釋

真正開發一個應用程序，大多情況下都是團隊合作。所以，在編寫程序時，為了使代碼更易于閱讀，通常會在實現功能的同時為代碼加一些注釋。注釋是對程序的某個功能模塊或者某行代碼的解釋說明，以便其他人能輕松地閱讀代碼，了解其意圖。Java程序同樣需要添加必要的注釋，以增強可讀性，這些注釋只在Java源文件中有效，在編譯程序時，編譯器會自動忽略這些注釋信息，不會將其編譯到class字節碼文件中去。另外，注釋還可以屏蔽一些暫時不用的語句，等需要時直接將此語句的注釋取消即可。例如，在調試代碼時，徹底刪除代碼可能會誤刪，造成程序徹底癱瘓，這時候使用注釋就顯得異常輕松了。根據功能的不同，Java語言提供了如下3種注釋方式。

單行注釋：用于對程序的某一行代碼進行解釋。在注釋內容前面加雙斜杠“//”，Java編譯器會忽略掉這一行雙斜杠以后的信息，并且不會對其他代碼造成影響，使用比較靈活。單行注釋一般用來對聲明的變量、一行程序的作用進行簡要說明。具體示例如下：

    String tea_year = nul1;  // 定義一個String字符串，并為其賦值

多行注釋：用于注釋內容有多行的情況。在注釋內容前面以單斜杠加一個星號“/*”開頭，并在注釋內容末尾以一個星號加單斜杠“*/”結束，常用于注釋掉暫時不用的代碼、說明方法的功能等。具體示例如下：

    public class JavaaMultiline{　　　　　　　　 // 定義一個類
    　　 int age;　　　　　　　　　　　　　　　　// 定義一個變量
    　　 /**
    　　   * 主方法，程序的入口地址
    　　   */
    　　 public static void main(String[]args){
    　　　　 System.out.println("多行注釋");
    　　 }
    }

文檔注釋：用于對程序的結構、方法和屬性等進行說明，以單斜杠加兩個星號“/**”開頭，并以一個星號加單斜杠“*/”結束。在實際開發中，開發人員可以使用javadoc命令將文檔注釋內容提取生成正式的HTML格式的幫助文檔。對于初學者而言，文檔注釋并不是很重要，了解即可。具體示例如下：

    /**
       *作者：張晨光
       *公司：AAA軟件教育
       *功能：文檔注釋講解
       */
    public class JavaDoc{　　　　　　　　　　  // 定義一個類
       int age;　　　　　　　　　　　　　　　　// 定義一個變量
       /**
    　　 * 主方法，程序的入口地址
    　　 */
       public static void main(String[]args){
    　　　　System.out.println("文檔注釋");
       }
    }

知識點撥：javadoc是API文檔生成器，該工具解析一組Java源文件中的聲明與文檔注釋，生成一組HTML頁面，描述這些源程序中定義的類、內部類、接口、構造方法、成員變量等，JDK的API文檔就是javadoc工具生成的。