Javadoc开发文档使用总结

一、Javadoc文档简介

1、Javadoc概念

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

官方API说明文档效果展示

因为我们用IntelliJ IDEA编辑好Java项目以后，一般需要生成一个Javadoc文档供相关人员阅读，以便了解Java类或方法的作用。所以我们下面了解一下在Intellij Idea 中如何将代码中的注释生成HTML文档。

2、Javadoc文档注释

Java语言除了提供基本的代码注释以外，还提供了一种功能更加强大的注释形式：文档注释。如果编写Java源代码时添加了合适的文档注释，然后通过JDK提供的javadoc工具可以直接将源代码里的文档注释提取成一份系统的API文档。

注意：文档注释必须写在类、接口、方法、构造器、成员字段前面，写在其他位置无效。

如果想要了解Javadoc文档注释使用规范，可以参考：JAVA文档注释使用详解

二、IDEA下生成Javadoc

1、Java源文件

2、菜单栏Tools选择Generate JavaDoc...

3、简单设置一下就ok了，注意生成的javadoc的html文档会有很多，建议建一个新文件夹装它们

4、创建成功，效果和我们常看的API帮助文档差不多

创建完毕，IDEA会自动帮我们打开index.html

 

javdoc文档技术参考链接：

如何使用Intellij Idea生成JavaDoc文档

Intellij IDEA如何生成JavaDoc