Java零基础学习实践系列(十三)：JavaDoc

实践十三：JavaDoc

---

  上一节主要讲了Java中的包机制，本节讲一下如何生成JavaDoc文档。

---

1.理论整理

JavaDoc命令是用于生成子集API文档的。

参数信息：
@author 作者姓名
@version 版本号
@since 指明需要最早使用的jdk版本
@return 返回值情况
@throws 异常弹出情况

---

JavaDoc文档生成的2种方式：

1. 通过cmd命令窗口–输入jjavadoc -encoding UTF-8 -charset UTF-8 写有注释的类名 —回车生成javadoc在线文档;
2. 通过IDEA —Tools–Generate JavaDoc --生成.

---

2.实践

1. 通过cmd命令窗口生成JavaDoc文档

1. 写一份带注释的程序
   
2. 找到你写注释的java类文件，然后在地址栏前加上$cmd$调出命令窗口
3. 在命令窗口输入：
   javadoc -encoding UTF-8 -charset UTF-8 JavaDOc.java
   生成JavaDoc文档
   
   
   

---

2. 通过IDEA生成JavaDoc文档

---

---

总结：本节介绍了2中生成javadoc解释文档的方式，常练习就可以熟练了~

---

注：本系列是"狂神说java"课程的个人学习笔记，无意侵权。