JavaDoc文档入门使用

JavaDoc文档

可以去百度搜索java se 文档，就可以找到java官方文档了链接如下

java SE API文档

可以看到许许多多有关java的类库

JavaDoc文档

1. javaDoc作用在类上@author 表示作者，@version表示版本，@since代表开始的jdk版本
2. javaDoc作用在方法上，@param代表传入参数，@return代表返回值，@throws代表抛出异常
3. 具体看考一下代码

/**
 * @author ChenJiaixong
 * @version 1.o
 * @since 1.8
 */
public class Hello {

          String name;

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

}

然后去该.java文件所在的目录下去执行javadoc -encoding UTF-8 -charset UTF-8 文件名

运行截图如下

运行之后可以发现改java文件目录下生成了许多文件如下所示

点击其中的index.html在浏览器中打开，可以发现与官网的java se API 在线文档十分类似，但是这次却是自己写的

如何使用IDEA生成javaDoc帮助文档可以参考如下网址

IDEA生成javadoc