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

IDEA生成java项目的javaDoc文档

目录 (Catalog)

[TOCM]

文章目录

  • IDEA生成java项目的javaDoc文档
    • javaDoc文档长相
    • 生成操作过程
    • 填入必要配置
    • 代码注释设置

javaDoc文档长相

java入坑系列6-IDEA生成java项目的javaDoc文档_第1张图片

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

生成操作过程

以idea 2020.1为例

  • Tools–>Generate JavaDocjava入坑系列6-IDEA生成java项目的javaDoc文档_第2张图片

填入必要配置

java入坑系列6-IDEA生成java项目的javaDoc文档_第3张图片

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

代码注释设置

  • 对在类的注释
    java入坑系列6-IDEA生成java项目的javaDoc文档_第4张图片
    以后新增类就是自己填入必要类头注释
/**
 * 

javaBase

*

学生类

* * @author tanjy * @version 1.0 * @since 2020-05-06 22:07 **/
public class Student { }

java入坑系列6-IDEA生成java项目的javaDoc文档_第5张图片

你可能感兴趣的:(java学习记录)