javadoc命令使用

javadoc指令基本使用

Java 文档注释是用来生成 API 文档的。Java 文档注释以/**开始，并以*/结束，可以通过 Javadoc 生成 API 帮助文档，Java 帮助文档主要用来说明类、接口、方法、成员变量、构造器和内部类。

Javadoc （Java API 文档生成器）是一种从源代码中的文档注释生成 HTML 格式的 API 文档的工具。

示例代码：

/**
 * 使用javadoc命令生成API文档
 *
 * javadoc -encoding UTF-8(编码格式) -charset UTF-8(字符格式) Doc.java(需要生成API的文件)
 * javadoc -encoding UTF-8 -charset UTF-8 Doc.java
 *
 * @author likelong
 * @version 0.0.1
 */
public class Doc {

    /**
     * 打印参数
     *
     * @param some 参数
     */
    public void show(String some) {
        System.out.println(some);
    }
}

常用命令：javadoc -encoding UTF-8 -charset UTF-8 Doc.java

在文件位置输出cmd进入小黑窗，输入上述命令即可生成HTML 格式的 API 文档的工具。

实际操作如下图：

结果：

点开Doc.html如下：