JavaDoc是用来生成自己API文档的。
JDK帮助文档,在线的API帮助文档要保存下,供以后学习,网址在这里:
一、使用cmd命令生成
1.选中要生成JavaDoc的类,右键--show in explorer,即在文件资源器中打开所在文件夹的位置,shift+右键,选择---“在此处打开命令窗口”,>javadoc -encoding UTF-8 -charset UTF-8 XXXX.java
解释:中间的为编码,采用UTF-8编码,为防止出现中文乱码,字符集(charset)的编码也采用UTF-8
2.生成后就会发现,所在文件夹中多了一些index html等文件,打开.index(首页),就可以看到自己生成的API文档了。
二、使用IDEA生成
选中要生成的文件后,点击tools中的生成工具
做如下配置,前两处根据自己文件来,最后一处依然是设置编码格式,
到此,就生成成功了,用浏览器打开的文档如下图所示。