JavaDoc

参数信息

@author 作者名

@version 版本号

@since 指明需要最早使用的jdk版本

@param 参数名

@return 返回值情况

@throws 异常抛出情况

加在类上就是类的注释，加上方法上的就是方法的注释

可以在包中打开index.html文件查看自己编译的文档。

idea中生成Javadoc

IDEA生成 javaDoc文档

选着你要生成javaDoc文档文件的代码文件

1.在工具栏中找到 tool >> Generate JAVADoc…

-encoding utf-8 -charset utf-8 防止中文代码乱码