Javadoc文档

1.前言

Java中有三种注释方式。前两种分别是 // 和 /* */，主要用于代码的注释，以此来方便代码的可读性。第三种被称作说明注释或文档注释，它以 /** 开始，以 */结束，文档注释允许你在程序中嵌入关于程序的信息，有了这个注释就可以使用 javadoc 工具软件来生成信息，并输出到HTML文件中。

---

2.文档注释的格式

/**

* .........

* .........

*/

在开始的 /** 之后，第一行或几行是关于类、变量和方法的主要描述。

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

Javadoc的作用是针对整个方法或者整个类做一个简要的概述的，使得别人不通过看具体方法代码就能知道某个方法或者某个类的作用和功能。写了Javadoc的在别人使用到类时，将鼠标悬停到类上或者方法上，javadoc会以提示信息显示出来，这样开发者在跳进源代码中就能知道类或者方法的作用

Javadoc命令是用来生成自己API文档的，使用方式：

//使用命令行在目标文件所在目录输入javadoc +文件名.java
cmd 文件所在目录，然后输入命令： javadoc 文件名.java
命令：javadoc -encoding UTF-8 -charset UTF-8 Doc.java   //设置格式，防止出现乱码

---

3. 使用javadoc生成文档

命令： javadoc -d 文档存放目录 -author -version 源文件名.java

这条命令编译一个名为"源文件名.java"的 java 源文件，并将生成的文档存放在"文档存放目录"指定的目录下，生成的文档中 index.html 就是文档的首页。-author 和 -version 两个选项可以省略

---

4.常用标记

标记	说明
@author	标识一个类的作者
@version	指定类的版本
@param	说明一个方法的参数
@return	说明返回值类型
@see	查看相关内容，如类、方法、变量等。
@since	API在什么程序的什么版本后开发支持。

---

5.通过IDEA生成Javadoc

https://blog.csdn.net/vbirdbest/article/details/80296136

步骤：Tools --> Generate JavaDoc -->

注意要配置编码，如果不配置为生成乱码，还需要配置Output directory

---

此学习资料参考于：

https://blog.csdn.net/vbirdbest/article/details/80296136

https://www.cnblogs.com/renjing/p/javadoc.html