Javadoc（1）
下面的内容来源于菜鸟教程，有兴趣的同学可以移步
javadoc也叫做Java文档注释，以 /** 开始，以 */结束，典型的javadoc如下所示：
/**
* <p> 这个类绘制一个条形图 </p>
* @author xxx
* @version 1.0
*/
有说明，有作者，有版本号，一目了然，而符号@后面的单词不是随便写的，而是有固定格式的，常见的文档注释如下图：
| 标签 | 描述 | 示例 |
|---|---|---|
| @author | 标识一个类的作者 | @author description |
| @deprecated | 指名一个过期的类或成员 | @deprecated description |
| 指明当前文档根目录的路径 | Directory Path | |
| @exception | 标志一个类抛出的异常 | @exception exception-name explanation |
| 从直接父类继承的注释 | Inherits a comment from the immediate surperclass. | |
| 插入一个到另一个主题的链接 | ||
| 插入一个到另一个主题的链接，但是该链接显示纯文本字体 | 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. |
| 显示常量的值，该常量必须是static属性。 | Displays the value of a constant, which must be a static field. | |
| @version | 指定类的版本 | @version info |
其中常用的就数 @author @param @return了，作用于类或方法上 |
||
| 而生成javadoc的文件也比较简单，直接在命令行输入 |
javadoc xxx.java
即可，然后就可以看到当前类在HTML文件中的展开信息，这里推荐使用IDEA自带的文档生成方式：
Tools - Generate JavaDoc
然后就是参数的处理了，这里推荐文章点击跳转的指示
只需要自行指定路径和编码格式即可，然后就可以在文件夹下看到生成好的html文件
