Java注释：单行、多行和文档注释

[toc]

注释是对程序语言的说明，有助于开发者和用户之间的交流，方便理解程序。注释不是编程语句，因此被编译器忽略。

Java支持三种注释：单行注释，多行注释，文档注释。

一单行注释

以双斜杠“//”标识，只能注释一行内容，用在语句后面或者注释信息内容少的地方。

如下所示：

    System.out.println("单行注释方式。");//这是单行注释方式，放在代码行后面。
    //这也是是单行注释方式。
    System.out.println("这也是单行注释方式，放在代码行上面。");

包含在"/*"和“*/”之间，能注释很多行的内容。为了可读性比较好，一般首行和尾行不写注释信息（这样也比较美观好看），如下所示。

注意：多行注释可以嵌套单行注释，但是不能嵌套多行注释和文档注释。

    /*
    *  这是多行注释，
    *  可以注释多行内容。
    *  这里的*是可以去掉的。
    *  为了美观，IDEA自动加上了。
    *  //这里嵌套了单行注释。
    */
    System.out.println("多行注释方式。");

包含在“/**”和“*/”之间，也能注释多行内容，一般用在类、方法和变量上面(这几个概念后面会讲)，用来描述其作用。注释后，鼠标放在类和变量上面会自动显示出我们注释的内容，如下所示。

注意：文档注释能嵌套单行注释，不能嵌套多行注释和文档注释，一般首行和尾行也不写注释信息。

/**
 *  这文档注释，
 *  可以注释多行内容。
 *  这里的*是可以去掉的。
 *  为了美观，IDEA自动加上了。
 *  //这里嵌套了单行注释。
 *  这里注释用在了类上。
 */
public class JavaComment {
    ... 
}

了解一下：文档注释可以通过 Javadoc 命令把文档注释中的内容生成文档，并输出到 HTML 文件中，方便记录程序信息。还可以包含一个或多个 @ 标签，每个 @ 标签都在新的一行开始。

如下图，将鼠标悬停标记1，在println方法的位置，可以看到自动弹出来对于该方法的文档注释。

文档注释查看

空白行或者有注释的行，Java 编译器都会忽略掉。也就是说代码中的空白行可以是任意的，只要不影响美观和阅读。空行一般也是为了美观阅读。

一起学习，Java最简单易懂的零基础入门，答疑解惑，关注点赞github开源：https://github.com/BradYan/easy-java