注释

注释 (comment) 分为三种: 单行注释, 多行注释, 文档注释.

注释既不参与编译, 也不参与运行. 所以注释仅存在于 .java 文件中, .class 文件中没有注释.

Java 的注释不会出现在可执行程序中, 因此可以在源代码中添加任意多的注释, 不必担心代码膨胀.

单行注释的格式:

// 单行注释

程序示例:

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 解析, 生成一套以网页文件形式体现的该程序的说明文档, 一般写在类中.

文档注释一般用来对类做解释.

图 1

javadoc 标签有很多, 常见的有 author, version 等.

代码示例:

// 文档注释
 
/**
*	@author xiao cheng
*	@version 0.01
*/
public class Comment {
	public static void main(String[] args) {
	}
}

在 CMD 窗口利用命令:

javadoc -d 想要存储即将生成的网页文件的文件夹 -xx -yy (或更多) 源文件名.java

xx, yy 等是 javadoc 标签名, 如 author, version 等.

生成的文件如下:

图 2