1. JavaDoc命令用来生成自己的API文档
(1)JavaJDK8内置帮助文档网址:https://docs.oracle.com/javase/8/docs/api/
(2)生成文档注释:/**+回车
(3)类的文档注释(加在类上面):
(4)方法的文档注释(加在方法上面):
2.cmd生成JavaDoc文档
(1)在文件夹中打开:右键Doc类 > Open In > Explorer
(2)在资源管理器的地址栏中打开cmd,方法详见之前的博客【打开cmd的四种方式】。用javadoc生成帮助文档:
按Enter键后,生成很多html:
(3)回到文件夹,发现多了很多的.html文件,双击index.html,生成了类似JavaJDK8内置帮助文档的内容:
生成的html文档:
3.IDEA生成JavaDoc文档(参考博客【使用IDEA生成JavaDoc文档(IDEA2020.3.2)】)
(1)【Tools】–【Generate JavaDoc】
(2)生成JavaDoc
① 选择生成JavaDoc文档的范围,我只对源文件生成Doc,所以选择文件
② 输出目录最好新建一个文件夹,更具条理和整洁性
③ 区域设置,决定文档的语言,简体中文就是zh_CN、繁体(台湾)zh_tw、繁体(香港)zh-hk、英语(香港)en-hk、英语(美国)en-us、英语(英国)en-gb、英语(全球)en-ww
④ 如果区域设置为中国,参数一般为-encoding UTF-8 -charset UTF-8
,防止中文乱码
(3)查看JavaDoc文档
打开上一步设置的输出目录,可看到成功生成,打开 index.html 便能看生成的文档。