2021-08-10 JavaDoc生产文档 Day 05

Java Doc

命令行生成JavaDoc文档

操作方法

1. 在src文件中new一个java class类，类名叫Demo06

2. 输入如图代码[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-DpbCTJnV-1628599789530)(C:\Users\ykw\AppData\Roaming\Typora\typora-user-images\image-20210808142333573.png)]

   • 在类上面的注释是类的注释；在类里面，方法上面的注释是方法的注释
   • 类的注释是自己打的，而方法的注释是通过public String test(String name) throws Exception自动生成的

3. 右击Demo06文件，找到Open In里的Explorer

   [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-eJzpFHHa-1628599789539)(C:\Users\ykw\AppData\Roaming\Typora\typora-user-images\image-20210808142904861.png)]

4. 跳转到该Demo06文件所属的文件夹

   [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-b8CE8i3K-1628599789544)(C:\Users\ykw\AppData\Roaming\Typora\typora-user-images\image-20210808143100912.png)]

5. 从该文件夹进入dos命令行

6. [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-2i3qcPSO-1628599789548)(C:\Users\ykw\AppData\Roaming\Typora\typora-user-images\image-20210808143217629.png)]

   • 输入javadoc -encoding UTF-8 -charset UTF-8 Demo06.java就可以生成文档了了

     [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-UJ0aWVgx-1628599789550)(C:\Users\ykw\AppData\Roaming\Typora\typora-user-images\image-20210808143441604.png)]

7. 点开index.html就可以看API文件了，

---

关于javadoc -encoding UTF-8 -charset UTF-8 Demo06.java的解释

• javadoc类似于javac，都是命令，javadoc就是java生成文档，javadoc后面要跟文件名.java
• -encoding UTF-8 -charset UTF-8是防止中文乱码
• Demo06.java是文件名.java

---

用IDEA生成JavaDoc文档

操作方法

• CSDN博客里面有