使用javadoc.exe生成Java api文档

喜欢ヅ旅行 2024-03-16 12:31 66阅读 0赞

**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文档**

![7feab6c6a52940348c306dbd3cc557fd.png][]

![c426bf307af64417920afce4f3b67a66.png][]

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 文件标题

![077f0e54760c48149603ec371bf55f8d.png][]

[7feab6c6a52940348c306dbd3cc557fd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/6381d49da84746a4a0fdc2d21f6ffbc3.png
[c426bf307af64417920afce4f3b67a66.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/f74fb7f25f404770a586e5b6ce8d9434.png
[077f0e54760c48149603ec371bf55f8d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/cd0c12c36cc34c0ba1d65a14b523c8ea.png