用javadoc命令生成自己的API文档

用javadoc命令生成自己的API文档




package base;

/**
 * @author bin 作者
 * @version 1.0 版本号
 * @since 1.15  jdk版本
 */
public class Doc {
    String name;
    /**
     * @author bin
     * @param name  参数名
     * @return  返回值情况
     * @throws Exception  异常抛出情况
     */
    public String test(String name)throws Exception {
        return name;
    }
}

输入以上代码

右击类,点击open in explorer

在弹出的文件夹导航栏前输入CMD打开命令行

在命令行中输入以下代码

javadoc -encoding  UTF-8 -charset UTF-8 Doc.java

(Doc为类名)

然后可以看到输出了以下内容

![](C:\Users\Public\Pictures\Sample Pictures\DOC.jpg)

查看类所在文件夹发现多出了很多内容

![](C:\Users\Public\Pictures\Sample Pictures\DOC1s.jpg)

点击index.html查看自己的API文档

![](C:\Users\Public\Pictures\Sample Pictures\DOC12.jpg)

该网站链接

上一篇:JavaDoc生成文档


下一篇:Java基础语法