Java小技巧自动生成注释、api文档

cmd 命令 javadoc的使用

首先你得安装好java以及配置好环境变量,能在cmd里面运行java,有关java环境配置参考:https://jingyan.baidu.com/article/6dad5075d1dc40a123e36ea3.html

win+R弹出运行窗口 输入cmd回车,进入dos界面,输入java -version,检查java是否配置好。如下图所示Java小技巧自动生成注释、api文档

配置好java后,我们新建一个含有公共类的java文件,在里面写点东西。

Java小技巧自动生成注释、api文档

然后保存到文件夹test里面,我们在文件夹里面空白处,按住shift键,然后点击鼠标右键,出现:在此处打开命令窗口,点击进入命令窗口,然后输入javadoc DemoA.java,回车。

Java小技巧自动生成注释、api文档

Java小技巧自动生成注释、api文档

如上图所示,正在生成api注释文档,生成的效果图如下所示,我们点击index.html即可查看文档。

Java小技巧自动生成注释、api文档

Java小技巧自动生成注释、api文档