注释

1.注释comment

注释是对代码的解释和说明的文字。目的是让人们能够更加轻松地了解代码。他不影响程序的编译和运行。Java中的注释包含单行注释、多行注释和文档注释。

1.1单行注释

单行注释以"//"开头换行结束，每个单行注释只能注释一行注释信息。

1.2多行注释

多行注释以"/*“开头，以”*/"结尾，多行注释可以注释多行注释信息。

1.3文档注释

文档注释以/**开头，以*/结束，文档注释也可以注释多行信息。

1.4 javadoc命令生成API文档

1.新建一个文本文件，完整的文件名修改为HelloWorld.java，其中文件名为HelloWorld，后缀名必须为.java。

2.用记事本打开。

3.在文件中保存以下代码：

/**
 @author  作者
 @version 1.0
 这是一个入门的Java代码，这是我们的第一个代码HelloWorld
 */
public class HelloWorld {
    /**
     @param args
     这是程序的入口方法名称叫main
     这个方法启动的时候会自动执行
     */
    public static void main(String[] args) {
        System.out.println("HelloWorld!");
    }
}

4.打开DOS界面，进入 HelloWorld.java 的目录下,输入以下命令行。

javadoc -charset GBK HelloWorld.java

5.进入 HelloWorld.java 的目录下。找到index.html, 可以发现文档注释的信息提取到API中去。

注意：

1.单行注释可以嵌套。
2.多行注释不可以嵌套多行注释
3.多行注释不可以嵌套文档注释
4.文档注释不可以嵌套多行注释
5.文档注释不可以嵌套文档注释

总结：三个注释都可以嵌套单行注释，但是不可以嵌套多行注释，和文档注释。