JavaDoc

JavaDoc

作用：一般用于注释类或方法，用于生成 自己 的API文档

---

如何生成自己的API文档

1.编写文档注释

package com.jun.base;

/**
 * @author dengjunwei
 * @version 1.0
 * @since 1.8
 */
//类的注释
public class Doc {

    String name;

    /**
     * @author dengjunwei
     * @version 1.0
     * @since 1.8
     * @param name
     * @return
     * @throws Exception
     */
//方法的注释
    public String test(String name) throws Exception{
        return name;
    }

    //通过命令行生成Javadoc文档   格式：Javadoc 参数 Java文件(面向百度编程查看具体命令)

    // javadoc -encoding UTF-8 -charset UTF-8 Doc.java

}

2. 打开项目文件目录

---

3. 打开控制台

4. 输入JavaDoc命令

格式：Javadoc 参数 Java文件(面向百度编程查看具体命令)