Javadoc介绍
Javadoc，通俗的来说就是在java中写的一个文档注释，用来显示java程序的作者，版本等一些信息（单独生成的一个index.html文档），形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时加入javadoc标签注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。
Javadoc使用方法
在写java程序的上边采用“ 多行注释加* ”的方法
idea中也可以对javadoc进行配置，详细配置可以参考： (在 IDEA 上优雅地使用 Javadoc_刘之帅的博客-CSDN博客
本人一般使用cmd下的命令行进行生成javadoc文档，
其中的-xx -yy 就是在文档中写入的javadoc标签（如果写有多个javadoc标签，可以类比加入多个）
之后去对应文件夹下找到 index-all.html 文件打开进行观看。
Javadoc 标签
Javadoc 工具软件识别以下标签：
| 标签 | 描述 | 示例 |
|---|---|---|
| @author | 标识一个类的作者 | @author description |
| @deprecated | 指名一个过期的类或成员* | @deprecated description* |
| {@docRoot} | 指明当前文档根目录的路径 | Directory Path |
| @exception | 标志一个类抛出的异常 | @exception exception-name explanation |
| {@inheritDoc} | 从直接父类继承的注释 | Inherits a comment from the immediate surperclass. |
| {@link} | 插入一个到另一个主题的链接 | {@link name text} |
| {@linkplain} | 插入一个到另一个主题的链接，但是该链接显示纯文本字体 | Inserts an in-line link to another topic. |
| @param | 说明一个方法的参数 | @param parameter-name explanation |
| @return | 说明返回值类型 | @return explanation |
| @see | 指定一个到另一个主题的链接 | @see anchor |
| @serial | 说明一个序列化属性 | @serial description |
| @serialData | 说明通过writeObject( ) 和 writeExternal( )方法写的数据 | @serialData description |
| @serialField | 说明一个ObjectStreamField组件 | @serialField name type description |
| @since | 标记当引入一个特定的变化时 | @since release |
| @throws | 和 @exception标签一样. | The @throws tag has the same meaning as the @exception tag. |
| {@value} | 显示常量的值，该常量必须是static属性。 | Displays the value of a constant, which must be a static field. |
| @version | 指定类的版本 | @version info |
