Java基础12:JavaDoc

JavaDoc

JavaDoc命令是用来生成自己API文档的

参数信息

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

package com.kuang.base;

/**
 * @author tianyi
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    String name;

    /**
     * @author tianyi
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}

---

终端进入需要生成文档的文件夹然后输入：javadoc -encoding UTF-8 -charset UTF-8 Doc. java 编译成文档以进行阅读。

//通过命令行 javadoc 参数 java 文件
//作业：学会查找使用IDEA生产JavaDoc文档！ 面向百度编程！
//基础部分的一切知识，后面几乎每一天都会用