JavaDoc生成文档

JavaDoc是一种将注释生成HTML文档的技术，生成的HTML文档类似于Java的API，易读且清晰明了。

• @author 作者名

• @version 版本号

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

• @param 参数名

• @return 返回值情况

• @throws 异常抛出情况

下面是几种文档生成方式

1、通过命令 javadoc  java文件

选中类右键选择OpenIn-->Explore打开文档

cmd进入命令行，输入命令 javadoc -encoding UTF-8 -charset UTF-8 TestJUC.java

其中-encoding UTF-8 -charset UTF-8是为了解决中文乱码问题

再次打开文件夹看到多出的文件

 打开index.html

 打开类生成详细信息，说明javadoc和javac一样可以编译生成可阅读文档

 2、通过idea生成javadoc文档

导航栏tools选择generateDoc...

zh_CN也是为了解决中文乱码问题

 控制台输出信息

 打开指定的输出文件

 打开index.html，也可以看到详细信息