使用javadoc.exe生成Java api文档

1.javadoc.exe 是 JDK 中的一个命令行工具，可以根据代码中的文档注释自动生成 API 文档。使用 javadoc.exe 生成 API 文档的步骤如下：

1. 编写源码，并在适当的位置添加文档注释。

2. 打开命令行窗口，进入源代码所在的目录。

3. 执行如下命令：

 javadoc -encoding UTF-8 -d doc -author -version *.java

其中，各个选项的含义如下：

• -encoding：指定源文件的编码格式，默认为平台默认编码（如：UTF-8）。
• -d：指定生成的 API 文档的存放目录。
• -author：生成的 API 文档中是否包含作者信息。
• -version：生成的 API 文档中是否包含版本信息。
• *.java：表示对当前目录下的所有 Java 源文件生成 API 文档。

   4.等待命令执行完成，生成的 API 文档会存放在指定的文档目录中。 

 

示例：

假设有一个名为 “Person.java” 的源代码文件：

/**
 * 这是一个表示人的类。
 */
public class Person {
    
    /** 姓名 */
    private String name;
    
    /**
     * 构造方法。
     * @param name 姓名
     */
    public Person(String name) {
        this.name = name;
    }
    
    /**
     * 获取姓名。
     * @return 姓名
     */
    public String getName() {
        return name;
    }
}

执行以下命令：

javadoc -encoding UTF-8 -d doc -author -version Person.java 

则会在当前目录下生成一个名为 “doc” 的文件夹，其中包含一个名为 “index.html” 的文件，打开该文件即可查看生成的 API 文档。 

2.在idea中生成API文档

 

javadoc -d napi -author A.java -charset utf-8 -encoding utf-8 - windowtitle 

1.  -author  作者名
2. -charset utf-8 编码格式
3. -encoding utf-8 文件编码格式
4. - windowtitle  文件标题