java入坑系列6-IDEA生成java项目的javaDoc文档

IDEA生成java项目的javaDoc文档

目录 (Catalog)

[TOCM]

javaDoc文档长相

• javadoc为一个优雅的项目类文档，使用idea是怎样生成呢？

生成操作过程

以idea 2020.1为例

• Tools–>Generate JavaDoc

填入必要配置

• 点ok就是生成漂亮的项目类文档啦

代码注释设置

• 对在类的注释
  
  以后新增类就是自己填入必要类头注释

/**
 * <h3>javaBase</h3>
 * <p>学生类</p>
 *
 * @author tanjy
 * @version 1.0
 * @since 2020-05-06 22:07
 **/
public class Student {
}