# Java Doc

1. javadoc 命令是用来生成自己API文档
2. 参数信息
   - @author作者名
   - @version版本号
   - since 指明需要最早使用的JDK版本
   - @param参数名
   - @return返回值情况
   - @throws异常抛出情况

**JDK帮助文档**

- https://docs.oracle.com/javase/8/docs/api/

在线API帮助文档

```java
package com.taylorhe.base;
/**
 * @author taylorhe
 * @version 1.0
 * @since 1.8
 */
//这是类的注释
public class Doc {
  String name;

    /**
     * @author taylorhe
     * @param name
     * @return
     * @throws Exception
     */
//这是方法的注释
  public String test(String name) throws Exception{
      return name;
//我是通过命令行  Javadoc  参数 Java文件
  }
}

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

//作业：学会查找使用IDEA生成Javadoc文档 面向百度编程

记得文件位置，保持一致