Day03_java基础 JavaDoc生成文档

java Doc

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

package com.kuang.base.opertaor.base;

/**
 * @author lemon
 * @version 1.0
 * @since 1.8
 *
 */
public class Doc {
    String name;//类变量       属性

    /**
     * @author lemon
     * @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文档呢？

1. 首先新建一个文件夹，用于存放要生成的Javadoc文档
2. 接下来点击IntelliJ IDEA顶部的Tools菜单，选择Generate JavaDoc选项，如下图所示

3. 然后在弹出的界面中选择如下信息，如下图所示

4. 然后在弹出的界面中我们点击Output directory输入框后面的按钮，选择存放路径

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

6. 传入JavaDoc的参数，一般这样写 -encoding UTF-8 -charset UTF-8

-encoding utf-8 -charset utf-8

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

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