API文档的自动生成

1.概述

当开发一个大型软件时，需要定义成千上万个类，而且需要很多人参与开发。 每个人都会开发一些类，并在类里定义一些方法和域提供给其他人使用，但 其他人怎么知道如何使用这些类和方法呢？ API文档就是用来说明这些应用程序接口的文档。

2.使用javadoc命令生成文档①

在想要生成API文档的文件所在文件夹下，打开cmd输入：

javadoc -d doc *.java

这种情况下可能出现编码错误的情况

在这里插入图片描述

javadoc -d F:\1QianFeng\课堂备份\20200724\课堂代码\0724\src\com\qf\gp2002\doc Dog.java -encoding UTF-8 -charset UFT-8

这样完善一下，确定接口文档的位置，目标文档，以及编码格式，生成如下文档

在这里插入图片描述

3.使用idea直接生成文档②

在这里插入图片描述

在这里插入图片描述