day16 Java基础——JavaDoc生成文档

day16 Java基础——JavaDoc生成文档

1. 什么是JavaDoc

JavaDoc是一种标准的、用于生成Java代码API文档的工具。它通过在Java源代码中特定的注释标签（如@author, @param, @return等）来提取类、接口、方法、字段等的信息，并自动生成格式化的HTML文档。JavaDoc文档可以帮助开发者理解和使用Java类库，提高代码的可读性和维护性。开发者可以使用JavaDoc工具直接从源代码中生成这些文档。

在线API帮助文档 https://docs.oracle.com/javase/8/docs/api/

2. 生成JavaDoc

package com.study.base;

/**
 * @author study
 * @version 1.0
 * @since 1.8
 */

public class Doc {

    String name;

    /**
     * @author study
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }


}

编译成文档

2.1 通过命令行生成JavaDoc

当前目录下cmd输入javadoc -encoding UTF-8 -charset UTF-8 Doc.java


可以看看index.html

及里面的doc

2.2 使用IDEA生成JavaDoc

第一步：选择生成JavaDoc文档的范围，我只对一个源文件生成Doc，所以选择文件。
第二步：输出目录最好新建一个文件夹，比较有条理和整洁
第三步：区域设置，决定文档的语言，简体中文就是zh_CN、繁体(台湾)zh_tw、繁体(香港)zh-hk、英语(香港)en-hk、英语(美国)en-us、英语(英国)en-gb、英语(全球)en-ww
第四步：其他命令行参数：如果区域设置为中国，参数一般为-encoding UTF-8 -charset UTF-8
第五步：设置完成后点击确定即可生成Doc文档

效果

部分内容引用
https://blog.csdn.net/qq_44122193/article/details/114789427
https://www.bilibili.com/video/BV12J41137hu/?p=32&share_source=copy_web&vd_source=7f3536a42709e7d479031f459d8753ab