JavaDoc生成文档【个人回顾总结版】

• 一、Java Doc
• 二、使用命令行生成Java Doc文档

一、Java Doc

Javadoc的作用是针对整个方法或者整个类做一个简要的概述的，使得别人不通过看具体方法代码就能知道某个方法或者某个类的作用和功能。
写了Javadoc的在别人使用到类时，将鼠标悬停到类上或者方法上，javadoc会以提示信息显示出来，这样开发者在跳进源代码中就能知道类或者方法的作用。

JavaDoc命令就是用来生成自己API文档的
通常在类或者方法上使用/** */来表示

参数信息：
@author 作者名
@version 版本号
@since 指明需要最早使用的jdk版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况

二、使用命令行生成Java Doc文档

1、编写 Demo01类 ，并在其中编写用来生成JavaDoc文档的 文档注释

package com.kuang.shen;

/**
 * @author ctgu
 * @date 2022/6/1 20:03
 * @version 1.0
 * @since 1.8
 */
public class Demo01 {

    String name;

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

2、来到Demo01这个所在的文件夹下

点击上面的操作以后，来到了Demo01文件夹下

复制这个Demo01类的路径，并且以 win+R cmd 打开命令行。

cd 你复制的路径

eg:
cd D:projectideapaperfreesrcmainjavacomkuangshen

并且执行下面命令生成JavaDoc文档

javadoc 可增加参数 Demo01.java(类名.java)

eg:
javadoc -encoding UTF-8 -charset UTF-8 Demo01.java

到Demo01这个类的文件夹下(也就是上面复制的路径的位置)

打开 index.html ,这个就是我们生成的JavaDoc API文档

三、使用IDEA生成JavaDoc文档

1、Tools——>Generate JavaDoc

2、图片中的第4部分一般这样写： -encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api

3、在控制台查看输出信息

4、在输出地址中查看 index.html ，来查看生成的JavaDoc文档