2.5 代码注释

所谓注释，就好比在日常生活中听老师讲课所作的笔记，笔记的作用是解释知识点，帮助加强记忆。在Java中，程序中通常给出一些解释，可以提示某段代码的作用，这就是Java中的代码注释。注释只是给人看的，为了让别人读懂这段代码，注释的代码是不被编译的，所以不用担心执行效率的问题。

2.5.1 行注释

行注释就是一整行的注释信息，单行注释也是最常用的，行注释的符号是“//”，在注释符号后面一整行都被作为注释信息。例如下面的小程序。

【范例2-3】示例代码2-3是一个进行单行注释的程序。

示例代码2-3

        public class HelloWorld
        {
            //这是Java程序的入口方法
            public static void main(String args[])
            {
                System.out.println("欢迎使用Java来编写程序！");
            }
        }

【代码解析】注释就是一整行的注释信息，行注释的符号是“//”，在注释符号后面一整行都被作为注释信息。

2.5.2 块注释

所谓块注释和行注释是一个意思，都是注释信息的意思，起到提示的作用。块注释的符号是“/* */”，以“/*”开始，以“*/”结束，在这个区域内的文字都将作为注释信息。例如下面的小程序。

        /＊
            @param name
            @author amer
        ＊/

2.5.3 文档注释用户自定义类型

所谓文档注释是描述类的，通过在类里定义的文档注释，可以帮助程序员了解此类具有哪些功能，以及此类的相关信息。文档注释是Java特有的doc注释，它以“/**”开头，以“*/”结尾，把前面的例子加以修改得到如下示例。

【范例2-4】例如下面的小程序。

示例代码2-4

        /＊＊
        作者 amer
        ＊/
        public class HelloWorld
        {
            public String name; //成员变量
            /＊＊
            Java程序的主入口方法
            参数为 args
            ＊/
            public static void main(String args[])
            {
                System.out.println("环境使用Java来编写程序！");
            }
        }

【运行结果】通过在命令行下输入命令“javadoc HelloWorld.java”，来生成网页文档，会生成一个doc注释。如图2-1所示。

图2-1 用命令javadoc来生成文档

命令执行完毕后，会在程序的源代码的同目录下生成和文档相关的HTML文件，如图2-2所示运行index.html打开文档，文档运行的界面如图2-3所示。

图2-2 生成的HTML文件

图2-3 文档注释