Java基础语法 ------ Java注释

Java的三种注释

Java支持三种注释方式：单行注释、多行注释和文档注释。

注释是什么？

在Java的编写过程中我们需要对一些程序进行注释，除了自己方便阅读，更为别人更好理解自己的程序，所以我们需要进行一些注释，可以是编程思路或者是程序的作用，总而言之就是方便自己他人更好的阅读。注释是用于解释说明代码和程序的，方便程序员阅读代码，它会被编译器忽略，所以不会影响程序的运行效率。

1. 单行注释

“//”：以双斜杠开头，通常习惯在后面加上一个空格，这样表示单行注释，顾名思义，这样的注释方法，其注释的内容只能在一行中。所以通常用于解释一行代码语句。

public class annotation {
    public static void main(String[] args) {
        // 控制台输入“java单行注释”字符串
        System.out.println("java单行注释");
    }
}

2. 多行注释

以“/”开头，以“/”结束，中间是注释内容，允许注释多行的内容。为了高可读性和美观，一般首行和尾行不写注释信息。

public class MutilineComment {
    public static void main(String[] args) {
        /*
         * 这是一个多行注释
         * 在控制台中显示"多行注释"字符串
         * 巴拉巴拉
         * // 多行注释中可以嵌套单行注释哦
         */
        System.out.println("多行注释");
    }
}

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

3. 文档注释

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

/**
 * @author Leung
 * @version 1.0
 * @deprecated 这是一个展示文档注释的类
 */
public class DocumentAnnotation {
    /**
     * 程序的入口
     * @param args
     */
    public static void main(String[] args) {
        System.out.println("文档注释");
    }
}

idea中，点击 Tools --> Generate JavaDoc，选择需要生成文档的包或者类，即可在指定目录下生成文件，其中有一个index.html,打开即可看到。

总结

在Java中，无论是哪一种注释方式，Java编译器都会忽略其中的注释内容，所以无论你写多少注释内容，程序的性能都不会受到影响。注释是为了方便程序员阅读和理解代码的一种方式。