Java基础12：JavaDoc生成文档

文档注释

参数信息

@author  作者名

@version  版本号

@since  指明需要最早使用的jdk版本

@param  参数名

@return  返回值情况

@throws 异常抛出情况

/**
 * @author Kunagshen
 * @version 1.0
 * @since 1.8
 */
//加在类的上面就是类的注释
public class Doc {

    String name;

    /**
     * @author Kuangshen
     * @param name
     * @return
     * @throws Exception
     */
//加在方法的上面就是方法的注释
    public String test(String name) throws Exception{
        return name;
    //看不懂没关系，知道这个意思就行
    }
}

利用JavaDoc命令生成文档

1，找到此文件的地址，可以在IDEA右键此文件 > Show in Explrer

2，导航栏cmd进入此文件，

3，输入命令：javadoc -encoding UTF-8 -charset UTF-8 Doc.java    encoding是编码的意思，charset是字符集的意思，中间的一堆参数是为了能多显示一些中文，防止遇到中文后乱码的情况

4，打开文件坐在的文件夹，里面会多了一堆东西，点开会进入一个网站，里面有很多东西

5，实例：搜索JDK帮助文档 > 点击是oracle官方的网站 > 点击相应的API文档版本

Overview (Java Platform SE 8 ) (oracle.com)

IDEA生成JavaDoc

1，IDEA 的 JavaDoc 生成功能在菜单 Tools->Generate JavaDoc 项里面。

2，里面有一个 Locale 可选填项，建议在此填写 zh_CN。
3，还有一个“Other command line arguments:”可选填项，非常重要，是填写直接向 javadoc.exe 传递的参数内容。因为有一些重要的设置，只能通过直接参数形式向 javadoc.exe 传递。这里必须要填写如下参数：

 4.点击OK即可将javadoc生成到指定目录。

【【狂神说Java】Java零基础学习视频通俗易懂】https://www.bilibili.com/video/BV12J41137hu?p=32&vd_source=04c9e32408f61b4fd8bec53b61c24bd9