[开发工具]IDEA写API文档的两种方法

包机制

包的本质就是文件夹

一般利用公司域名作为包名 com.baidu.www com.hestudy.www

导入包 import com.hestudy.Demo1;

导入包下所有的类：import com.hesudy.base.*;

推荐：阿里巴巴开发手册

JavaDoc

搜索JDK 帮助文档

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

①查找使用IDEA生成Javadoc文档

1. 首先新建一个文件夹，用于存放要生成的Javadoc文档。

2. 接下来点击IntelliJ IDEA顶部的Tools菜单，选择Generate JavaDoc选项

3. 然后在弹出的界面中我们点击Output directory输入框后面的按钮

4. 在弹出的选择文件夹界面中选择刚才新建的文件夹

5. 接下来在底部的Locale输入框配置语言和编码集，语言用zh_CN，代表中文，

   编码集用 -encoding utf-8 -charset utf-8

6. 然后点击确定以后我们就等待IntelliJ IDEA给我们生成JavaDoc文档即可，等到输出栏出现如下图所示的提示代表生成完毕

7. 接下来我们打开JavaDoc文件夹，找到index.html文件,点击就能看到API文档。

②命令行生成文档

1. 首先找到类的Show in Explorer
2. 在上方文件夹地址输入cmd加空格，enter进入
3. 在doc命令行输入javadoc -encoding UTF-8 -charset UTF-8 Doc.java
4. 接下来我们打开文件夹，找到index.html文件,点击就能看到API文档

参数信息

1. @author：作者名

2. @version：版本号

3. @since：指明需要最早使用的jdk版本

4. @param:参数名

5. return：返回值情况

6. throws：异常抛出情况

/**

 * @author  hetingting

 * @version 1.0

 * @since 1.8
  */
   public class Doc {
   String name;

    /**

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