如何使用Intellij Idea生成JavaDoc文档

JavaDoc是一种将注释生成HTML文档的技术，生成的HTML文档类似于Java的API，易读且清晰明了。在简略介绍JavaDoc写法之后，再看一下在Intellij Idea 中如何将代码中的注释生成HTML文档。

先看一段样例代码:

//: POI/ExportConfig
/** Excel导出项配置
 * @author Mr zhang
 * @version 1.0
 * @since 1.8
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.FIELD })
public @interface ExportConfig {

	/**
	 * @return 表头显示名(如：id字段显示为"编号") 默认为字段名
	 */
	String value() default "field";

	/**
	 * @return 单元格宽度 默认-1(自动计算列宽)
	 */
	short width() default -1;

	/**
	 * 将单元格值进行转换后再导出：

	 * 目前支持以下几种场景：

	 * 1. 固定的数值转换为字符串值（如：1代表男，2代表女）

	 * 表达式: "s:1=男,2=女"

	 * 
	 * 2. 数值对应的值需要查询数据库才能进行映射(实现com.haohuo.util.poi.convert.ExportConvert接口)

	 * 
	 * @return 默认不启用
	 */
	String convert() default "";

	/**
	 * @return 当前单元格的字体颜色 (默认 HSSFColor.BLACK.index)
	 */
	short color() default HSSFColor.BLACK.index;

	/**
	 * 将单元格的值替换为当前配置的值：

	 * 应用场景: 

	 * 密码字段导出为："******"
	 * 
	 * @return 默认true
	 */
	String replace() default "";
}///:~  

稍微说一下常用的注解及其作用：

首先规则：以//: 开始，以///:~结束。

• @author 作者名

• @version 版本号

• @since 指明需要最早使用的jdk版本

当然还有一些其他注解，例如在类的方法上：

• @param 参数名

• @return 返回值情况

• @throws 异常抛出情况

看IDEA如何配置后生成javadoc文档

• one
  
• two
  
  解释一哈：

1. 选择是整个项目还是模块还是单个文件

2. 文档输出路径

3. Locale 选择地区，这个决定了文档的语言，中文就是zh_CN

4. 传入JavaDoc的参数，一般这样写 -encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api

可以看到控制台的输出：

然后找到生成的html：

看一下效果：

小功告成?