Java基础11：JavaDoc生成文档

本节内容教学视频连接：https://www.bilibili.com/video/BV12J41137hu?p=32&vd_source=b5775c3a4ea16a5306db9c7c1c1486b5https://www.bilibili.com/video/BV12J41137hu?p=32&vd_source=b5775c3a4ea16a5306db9c7c1c1486b5

1.什么是JavaDoc？

        Javadoc是一个由Sun公司提供的工具，‌用于从Java源代码中提取注释，‌生成API文档。‌

2.JavaDoc有什么功能？

        Javadoc的主要功能是从Java源代码中抽取类、‌方法、‌成员等注释，‌形成一个与源代码配套的API帮助文档。‌这意味着，‌在编写Java程序时，‌通过使用特定的注释标签，‌可以在程序完成后利用Javadoc工具生成详细的文档，‌这些文档包括类、‌方法的概述、‌参数、‌返回值等信息，‌从而为开发者提供使用指南。‌

        Javadoc的作用不仅限于为开发者提供使用指南，‌它还支持从源代码中提取用户提供的文档，‌这些文档可以是类、‌方法或字段的描述、‌参数说明等。‌通过这些信息，‌Javadoc能够生成一个结构化的内部表示，‌包括类层次结构和使用关系，‌最终生成HTML格式的文档。‌这意味着，‌即使在API实现之前的设计阶段，‌也可以编写文档注释并运行Javadoc工具，‌以便在设计早期就获得文档。‌

        此外，‌Javadoc还支持各种选项和参数，‌如指定输出目录、‌包含或排除特定的包、‌设置区域设置、‌编码等，‌以满足不同的文档生成需求。‌通过这些功能，‌Javadoc极大地简化了API文档的生成过程，‌提高了开发效率和代码的可读性

3.通过命令行方式生成JavaDoc文档

第一步：在代码中写好文档注释

package basic;

/**
 * @author zhangjianjian
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    String name;
    /**
     * @author zhangjianjian
     * @param name
     * @return name
     * @throws 
     */
    public String test(String name) throws Exception{
        return name;
    }
}

第二步：打开类所在的文件夹

第三步：进入cmd窗口

第四步：在cmd窗口中输入"  javadoc -encode UTF-8 -charset UTF-8 Doc.java  " 

4.通过IDEA生成javadoc文档