java基础——生成javadom

使用JavaDoc生成文档，就一定要写出代码的文档注释，关于注释的文章可以查看博主关于Java注释的文章。
下面列举博主觉得常用的一些文档注释标签：

我们先看一下JDK的标准文档，JDK8官方文档

下面博主介绍两种方式，一种为cmd窗口生成，一种为IDEA生成。

CMD方法

在目录前加入cmd

cmd D:\IdeaWorkspace\javascript\src

javadoc -encoding UTF-8 -charset UTF-8 -d C:\Users\admin\Desktop\Javadoc Circle.java

-encoding UTF-8：表示设置编码。
-charset UTF-8：也表示设置编码。
-d：表示输出目录。
Circle.java：表示我们要生成文档的类的java文件。

当我们看到这里，生成文档就已经成功了，这时我们打开我们输出的路径，我们可以看到如下文件：

我们选择index.html打开，我们就能看到与JDK文档类似的文档了。

IDEA方法

我们先在IDEA中打开Circle.java文件，然后选择Tools -> Generate JavaDoc…
打开后会出现如下：

我们根据自己的需求填好其中的内容，点击ok即可。然后我们进入我们输出的文件夹中也会看到如下：

我们还是打开index.html文件，发现与上面CMD输出的文档大体一致：

————————————————
版权声明：本文为CSDN博主「一眉程序猿」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/weixin_45935633/article/details/104109299