Java学习第四天 JavaDos生成文档

它可以生成我们Java文件的Api文档

JDK8帮助文档：

Overview (Java Platform SE 8 ) (oracle.com)

具体用法：

可以通过文本注释添加参数信息：

/**回车，参数信息如上。

写了一个Dos.java

接下来图和生成JavaDoc文档：

（1）通过命令行：

打开Java文件所在目录，前面加 cmd 空格,打开窗口：

 

 输入 javadoc -encoding UTF-8 -charset UTF-8 Doc.java

这时候在打开java文件存放位置，会发现多了好多东西

 

这些就是详细的API文档了。

（2）使用IDEA生成JavaDos文档

第一步，创建一个存放Dos的文件夹：

 第二步，打开IDEA

 

点击ok就生成了。

注：在使用idea生成javadoc文档的时候出现的问题：如果遇到Error running ‘Javadoc’: Cannot generate JavaDoc - JDK path is not specified or invalid，就按照下面的解决办法即可。

点击File --> 找到Project Structure  点击进去

 点击new 找到自己安装的jdk路径就可以了

 问题就解决了。