文档注释（利用javadoc工具）

Java程序员在开发中都会有查阅 API（Application Programming Interface）文档的需求，那么你是否也想给自己的代码生成一份“说明书呢”

JDK 包含一个很有用的工具，叫做 javadoc, 它可以由 Java 源文件生成一个HTML文档。

编写Java程序时，需为以下部分插入文档注释：

1. 包
2. 公有类与接口
3. 公有的和受保护的构造器及方法
4. 公有的和受保护的

文档注释内容可以被JDK提供的工具javadoc所解析，是java特有的，生成一套以网页文件形式体现的该程序的说明文档。

操作方法：例如：

在D:\javaTest\javaDemo\javaDemo01\src\com\tedu路径下新建一个txt文档，

package com.tedu;

/**
 * @author JAVA高手
 * @version 1.0
 * @date 2023-11-29 19:08
 *
 * 这是我的第一个java文件，我一定要成为编程高手！
 */
public class CommentTest {
    /*
       这是main()方法，格式是固定的。（多行注释）
        */

    /**
     这是main()方法，格式是固定的。（文档注释）
     */
    public static void main(String[] args) {

        //这是输出语句
        System.out.println("我会成为编程高手！");
    }
}

输入上面代码后，将后缀名改为.java，

在当前文件夹中打开终端，输入命令：

javadoc -d myDoc -author -version -encoding UTF-8 CommentTest.java

将会在当前文件夹中生成一个myDoc文件夹，打开后找到index.html

打开此文件

这就是你的代码的 HTML文档了。