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工具生成的。