javaDoc生成方式

命令行生成

在cmd控制台窗口上找到需要生成文件的路径，然后执行命令。

# javadoc -encoding UTF-8 -charset UTF-8 文件名
javadoc -encoding UTF-8 -charset UTF-8 Doc.java

这样就生成完成了。

测试Doc.java文件

package com.jiang.base;

/**
 * @author LongHaiJiang
 * @version 1.0
 * @since 1.8
 **/
public class Doc {
    String name;

    /*
    命令行生成JavaDoc文档命令：javadoc -encoding UTF-8 -charset UTF-8 Doc.java
     */

    /**
     * @param name 姓名
     * @return 姓名
     * @throws Exception 抛出异常
     */
    public String test(String name) throws Exception {
        return name;
    }
}

生成后文件会出现以下内容。

打开index.html就可以看见和官方文档类似的文档了。
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-PslAAH3P-1678018829770)(https://img2023.cnblogs.com/blog/3071671/202301/3071671-20230104001809756-921259161.png)]

使用idea生成JavaDoc文档

在idea顶部Tools下找到Generate JavaDoc…

在弹出窗口配置生成即可。

与命令行同样的生成了这部分文件。可以直接打开index.html查看。