Java Doc

Java Doc

• javadoc是用来生成自己的API文档的
• Javadoc参数

  • @author 作者名

  • @version 版本号

  • @since 知名需要最早使用的jdk版本

  • @param 参数名

  • @return 返回值情况

  • @throw 异常抛出情况

实例代码：

/**
 * @author lc
 * @version 1.0
 * @since 1.8
 */
 public class doc {

     String name ;

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

使用cmd命令行生成

1. 右键类名，点击打开文件夹

2. 在地址栏前面输入cmd，回车(在当前目录打开cmd)
3. 输入 javadoc -encoding UTF-8 -charest UTF-8 doc.java

4. 之后我们返回刚才的文件夹，找到index.html文件并打开就能看到cmd生成的doc文档了.(index-首页)

使用IDEA生成

1. 在IDEA上方工具栏中找到tool-Generate JAVADoc…

2. 点击之后会出现这样的窗口

3. 输入完成之后，点击ok。IDEA会生成并自动使用默认浏览器打开其中的index.html文件