从零开始学Java【06】

从零开始学Java【06】

---

学习视频：https://www.bilibili.com/video/BV12J41137hu?p=32

目录

• 从零开始学Java【06】
• 在idea里面Java文件里面添加注释
• 用cmd命令行生成JavaDoc文档
• 用idea生成javaDoc文档

Java中的注释有三种：

• 单行注释
• 多行注释
• 文档注释

其中文档注释即本文所讲内容，JavaDoc命令即可以生成文档注释

在idea里面Java文件里面添加注释

可以在类的上面编写文档，输入/**，按回车，再输入@就可以输入了

也可以给方法编写文档，输入/**，按回车，就自动有了文档注释了

显示这个方法返回值，抛出异常等等的信息，也可以自己额外加一些东西，比如@Author也可以加进去，可以加入的参数信息在第一张图

用cmd命令行生成JavaDoc文档

找到这个Java类，打开所在文件夹

用命令行打开

输入指令

javadoc -encoding UTF-8 -charset UTF-8 XXX.java

XXX为要生成文档的Java文件，图为生成Doc.java

打开index.html，为这个Java生成文档的主页

即可生成Doc.Java的文档

用idea生成javaDoc文档

使用IDEA产生JavaDoc文档

来源：https://www.cnblogs.com/wuxxxlgiteeio/p/15784705.html

1.首先创建一个存放JavaDoc的文件夹

2.然后在IDEA中打开如下目录

3.接着在这里选择创建Demo1文件夹的位置

4.然后在Local行和编码集写下如下代码，即可设置为中文且防止了中文带来的乱码

5.点击"ok"后IDEA便会自动生成JavaDoc文档，注意下方的输入栏出现以下语句即代表生成完毕。

6.接下来在Demo01文件夹中找到index.html文件（2021新版idea默认会自动打开）

7.打开后就会看到我们的JavaDoc文档了，会包含项目中的所有类和程序包。