JavaDoc生成文档

JavaDoc简介

javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。

javadoc命令是用来生成自己API文档的，使用方式：使用命令行在目标文件所在目录输入javadoc +文件名.java。

常用标记

标签	说明
@author 作者	作者名
@version 版本号	版本号
@param 参数名 描述	参数名
@return 描述	返回值情况
@throws异常类名	异常抛出情况
@since 描述文本	指明需要最早使用的jdk版本

生成JavaDoc文档有两种方式：

方式1、使用命令行生成JavaDoc文档

1.首先选中当前类，右击选中打开文件夹

2.在导航栏输入cmd回车

3.命令行输入 javadoc -encoding UTF-8 -charset UTF-8 TestThread1.java

因为文档中可能有中文，为了防止出现乱码，设置编码 -encoding UTF-8字符集编码 -charset UTF-8

4.执行成功生成很多html，其中index.html就是Java生成的文档

5.打开文档查看

方式2、Idea生成JavaDoc文档

1.在IDEA中选择Tools 选项卡下的Generate JavaDoc

2.配置各种参数

其中 -encoding UTF-8 -charset UTF-8  是为了显示中文不出现乱码

3执行成功

4.查看生成的Doc文档

总结

Javadoc是一种自动生成API文档的工具，并且它可以从源码中提取注释信息，在Java开发中具有很大的价值。它可以方便程序员之间的交流，使代码更加可读，减少开发者的时间成本，并且通过在系统上生成文档，使代码更容易维护。