注释

注释（comment）分为三种：单行注释，多行注释，文档注释。

注释既不参与编译也不参与运行，所以注释仅存在于 .java 文件中，.class 文件中没有注释，因此可以在源代码中添加任意多的注释而不必担心代码膨胀。

单行注释

单行注释的格式：

// 单行注释

程序示例：

public class Test {
    public static void main(String[] args) {
        String greeting = "Hello world";
        System.out.println(greeting);
        // 打印和字符串相同长度的分隔符
        for (int i = 0; i < greeting.length(); i++) {
            System.out.print("=");
        }
        System.out.println();
        System.out.println("yeah!!!");
    }
}

执行结果：

Hello world
===========
yeah!!!

多行注释

多行注释的格式：

/* 多行注释 */

多行注释里面不能再嵌套多行注释。

文档注释

文档注释一般写在类中，用来对类做解释。文档注释可以被 JDK 提供的工具 javadoc.exe 解析，生成一套以网页文件形式体现的该程序的说明文档。

javadoc.exe 工具：

图 1

文档注释的标签有很多，常见的有 author、version 等。

代码示例：

/**
 * @author You Kong
 * @version 0.01
 */
public class Test {
    public static void main(String[] args) {

    }
}

在 cmd 窗口利用命令生成 javadoc 文档：

javadoc -d D:\Java\Test\Javadoc -author -version Test.java

固定格式为：

javadoc -d 存储说明文档的文件夹 -xx -yy（或更多标签） 源文件名.java

效果：

图 2

生成的文件：

图 3

双击 Test.html 文件即可查看该类的说明文档：

图 4