【大数据Java基础系列】（四）：Java的三种注释

文章目录

• ​​1、单行注释​​
• ​​2、多行注释​​
• ​​3、文档注释​​

1、单行注释

单行注释是使用两个斜线，一般是用来解释下面命令是做什么的，或者是函数的功能的

public class main {
    public static void main(String[] args) {
        // 该语句是用来打印的
        System.out.println("hello");
    }


}

2、多行注释

多行注释是使用/* code */，中间是我们的注释内容，它与单行注释的区别就是它可以跨行注释，当我们的注释内容较多时，可以使用多行注释。

public class main {
    public static void main(String[] args) {
        /*
        该函数时用来打印hello的
        函数中有print函数
        */
        System.out.println("hello");
    }


}

3、文档注释

文档注释是Java语言独有的，一般是用来说明代码一些相关信息的，例如作者、日期、版本、代码描述等，文档注释的格式为前面是两个 ，后面为一个 ，即/ code */

/**
 * Created with IntelliJ IDEA
 * 作者: 阿光
 * 日期: 2022/11/22
 * 时间: 20:25
 * 描述: 第一个HelloWorld程序
 */
public class main {
    /**
     * 描述: 该函数为main方法
     *
     * @args: 命令行参数
     */
    public static void main(String[] args) {
        System.out.println("hello");
    }


}

编写java文件，在文件中使用文档注释

编写好文件后，使用javadoc进行解析，形成改代码的网页形式的说明文档

javadoc -d mydoc -author -version -encoding utf-8 main.java

然后目录中就会出现一个文件夹，该文件夹的名称就是我们指定中指定的，然后打开该目录下的index即可看到该代码的说明文档