JavaDoc

JavaDoc

javadoc 命令生成API文档

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

参数信息

1. @ author作者名

2. @ version版本号

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

4. @ paran参数名

5. @ return返回值情况

6. @ throws异常抛出情况

package com.gcbeen.base;

/** 
* @author gcbeen 
* @create 2021-05-26 10:20 
* @version 1.0 
* @since 1.8 
*/
public class Doc {

    String name;

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

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

Intellij IDEA生成 JavaDoc 文档

第一步：在工具栏中找到 Tool，然后再子菜单中找到 Generate JavaDoc。

第二步：在生成文档上进行配置。

配置的简单介绍：

参数说明

1.Whole project:整个项目都生成文档

2.Custom scope 自定义范围。如下：

（1）project files 项目文件，

（2）project production files 项目产品文件，

（3）project test files 项目的测试文件， 未知范围，class hierarchy 类层

3.include test source 包含测试目录

4.include JDK and … 包含jdk和其他的第三方jar

5.link to JDK documentation…链接到JDK api

6.output directy 生成的文档存放的位置

（1）private、package、protected、public 生成文档的级别（类和方法）

（2）右边的Generate…是选择生成的文档包含的内容，层级树、导航、索引..

（3）再右边是生成的文档包含的内容信息，作者版本等信息

7.Locale 语言类型,zh-CN

8.Other command line arguments 其他参数

9.Maximum heep… 最大堆栈

我这里的配置如下：

说明：IntelliJ IDEA作为Java流行的编辑器, 其生成一些Javadoc会对中文乱码, 使用UTF-8编码即可. 这个常见的问题, 则需要生成时设置参数即可.

在 “Tools->Gerenate JavaDoc” 面版的 “Other command line arguments:” 栏里输入 ：

传入JavaDoc的参数，一般这样写
-encoding UTF-8 -charset UTF-8 -windowtitle "文档HTML页面标签的标题" -link https://docs.oracle.com/javase/8/docs/api

不然的话会报可能会报错误: 编码GBK的不可映射字符。

Java帮助文档地址 Java Platform SE 8