JavaDoc生成文档

JavaDoc

JavaDoc命令是用来生成自己的API文档的

参数信息

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

可以去网上搜JDK帮助文档。

---

使用 cmd编写 JavaDoc命令

视频时间：4；36

P32Java基础12：JavaDoc生成文档

// cmd内输入代码
javadoc -encoding UTF-8 -charset UTF-8 Doc.java

//对应视频Doc

/**
 * @author kuangshen
 * @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;
    }

    //通过命令行（cmd）：javadoc 参数 Java文件

    //学会查找使用 IDEA生产 JavaDoc文档！    面向百度编程！

    //基础部分的一切知识，后面几乎每天都会用。

}

---

使用 IDEA生产 JavaDoc文档

1. 打开 idea，点击 Tools–> Generate JavaDoc，会弹出生成JavaDoc文档的配置页面。
   
   

2. 进行参数配置
   
   

3. 在输出目录里生成JavaDoc。