第十四讲——JavaDoc

第十四讲——JavaDoc

即是注释中的文档注释

/**
*
*/

---

JavaDoc 是用来生成自己的API文档（信息文档）| 用来解读和了解该程序的文档

---

包含参数信息；

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

---

范例； JDK-API帮助文档 ！！！TM 这里可以画流程图 爱了爱了

第一步 撰写注释

package Base;

/**
 * @author xiaozhong
 * @version 1.0
 * @sionce 1.8
 */
//写在类上就是写类的帮助文档
public class Doc {
    String name;

    /**
     *@author xiaozhong
     * @param name
     * @return
     */
    //方法的帮助文档
    public String test(String name) throws Exception { //throws Exception 抛出 异常
        return name;
    }
}

---

第二步 打开文件所在目录

第三步 打开命令符

技巧在目录前输入；

cmd+空格

直接打开当前目录的命令符

---

---

第四步 敲命令

---

本来应该显示

真正显示

根据网上资料初步分析判定

lib\dt.jar

lib\tools.jar

这两个jar包不存在。

下载的jdk有问题，需要重新下载

下载一定要去官网

参考网址

因为这个注释文档并不是很重要

所以不去深入研究

新增词汇

author 作者 啊sar~