JavaDoc的学习

JavaDoc的学习

Java在线的api帮助文档网址

点击进入api在线帮助文档
可以在里面看到Java内置的类

---

• javadoc命令是用来生成自己的api文档的

JavaDoc的参数信息

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

JavaDoc的使用

1. 在idea中定义一段类注释和一段方法注释如下

---

/**
 * @author qianchang
 * @version 1.0
 * @since 1.8
 */

//加在类上面作为类注释
public class Doc {
    String name;

    /**
     *
     * @param name
     * @return
     * @throws Exception
     */
    //加在方法上面作为方法注释
    public String test(String name) throws Exception{
        return name;
    }
}

2. 在idea中右键类找到open In 找到里面的explorer打开

3. 进入文件夹后在目录前加cmd打开命令提示符

4. 输入javadoc -encoding UTF-8 -charset UTF-8 类名.java 生成JavaDoc文件

5. 在生成的文件中打开index.html即可看到生成的文件网页（此网页和api帮助文档的网页格式一模一样）