Java基础：JavaDoc生成文档

本篇文章介绍生成JavaDoc的两种方法。

JavaDoc介绍

• JavaDoc命令是用来生成自己API文档的
• 参数信息

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

代码示例

package com.ibelifly.base;

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

Doc命令生成文档

• 命令如下：
  
• 在IDEA的软件包目录下选择在文件夹中打开，会看到生成的index.html文件
  
• 双击index.html，在网页中得到帮助文档
  

使用IDEA生成JavaDoc

2. 打开IDEA，选择工具—>生成JavaDoc
3. 配置生成文档
   
4. 点击确定，生成成功