使用javadoc生成API文档

最新推荐文章于 2024-04-30 20:34:13 发布

搬山境KL攻城狮

最新推荐文章于 2024-04-30 20:34:13 发布

阅读量327

点赞数

分类专栏：常用文章标签： maven java javadoc

本文链接：https://blog.youkuaiyun.com/ory001/article/details/119915464

版权

常用专栏收录该内容

54 篇文章

订阅专栏

本文详细介绍了如何利用IntelliJ IDEA和Maven的maven-javadoc-plugin工具，为Java项目自动生成UTF-8编码的API文档，包括单模块和多模块项目的配置，并提供了解决乱码问题的方法。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

使用javadoc生成API文档

文章目录

使用javadoc生成API文档

一、使用idea工具辅助生成javadoc文档

zh_CN

-encoding utf-8 -charset utf-8 -tag date:a:"日期:" -doctitle "示例"  -windowtitle "示例"

idea 开发工具 Tools->Generate JavaDoc

在这里插入图片描述

二、使用maven-javadoc-plugin辅助生成javadoc文档

1.单模块项目

    <profiles>
        <profile>
            <id>javadoc</id>
            <build>
                <plugins>
                    <!-- 生成javadoc文档包的插件 -->
                    <!-- https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html -->
                    <!-- https://maven.apache.org/plugins/maven-javadoc-plugin/ -->
                    <plugin>
                        <groupId>org.apache.maven.plugins</groupId>
                        <artifactId>maven-javadoc-plugin</artifactId>
                        <configuration>
                            <encoding>utf-8</encoding>
                            <docencoding>utf-8</docencoding>
                            <charset>utf-8</charset>
                            <tags>
                                <tag>
                                    <name>date</name>
                                    <placement>a</placement>
                                    <head>日期:</head>
                                </tag>
                            </tags>
                            <doctitle>示例</doctitle>
                            <windowtitle>示例</windowtitle>
                            <locale>zh_CN</locale>
                            <!-- 可选值 all none accessibility,html,missing,reference,syntax, - 代表排除某个group -->
                            <doclint>all,-missing</doclint>
                        </configuration>
                        <executions>
                            <execution>
                                <id>attach-javadocs</id>
                                <goals>
                                    <goal>jar</goal>
                                </goals>
                            </execution>
                        </executions>
                    </plugin>
                </plugins>
            </build>
        </profile>
        <profile>
            <id>source</id>
            <build>
                <plugins>
                    <!-- 生成sources源码包的插件 -->
                    <plugin>
                        <artifactId>maven-source-plugin</artifactId>
                        <configuration>
                            <attach>true</attach>
                        </configuration>
                        <executions>
                            <execution>
                                <id>attach-source</id>
                                <goals>
                                    <goal>jar-no-fork</goal>
                                </goals>
                                <phase>package</phase>
                            </execution>
                        </executions>
                    </plugin>
                </plugins>
            </build>
        </profile>
    </profiles>

若生成javadoc过程中，控制台出现乱码，可尝试以下操作:
-Dfile.encoding=GBK

maven

2.多模块项目

    <profiles>
        <profile>
            <id>javadoc</id>
            <build>
                <plugins>
                    <!-- 生成javadoc文档包的插件 -->
                    <!-- https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html -->
                    <!-- https://maven.apache.org/plugins/maven-javadoc-plugin/ -->
                    <plugin>
                        <groupId>org.apache.maven.plugins</groupId>
                        <artifactId>maven-javadoc-plugin</artifactId>
                        <!-- 是否传递给子模块 -->
                        <inherited>false</inherited>
                        <configuration>
                            <encoding>utf-8</encoding>
                            <docencoding>utf-8</docencoding>
                            <charset>utf-8</charset>
                            <tags>
                                <tag>
                                    <name>date</name>
                                    <placement>a</placement>
                                    <head>日期:</head>
                                </tag>
                            </tags>
                            <doctitle>示例</doctitle>
                            <windowtitle>示例</windowtitle>
                            <locale>zh_CN</locale>
                            <!-- 可选值 all none accessibility,html,missing,reference,syntax, - 代表排除某个group -->
                            <doclint>all,-missing</doclint>
                                                        <!-- 多个值之间使用:分割;可使用通配符* -->
                            <excludePackageNames>com.example.package1:com.example.package1.*</excludePackageNames>
                        </configuration>
                        <executions>
                            <execution>
                                <id>aggregate</id>
                                <goals>
                                    <goal>aggregate-jar</goal>
                                </goals>
                                <phase>package</phase>
                            </execution>
                        </executions>
                    </plugin>
                </plugins>
            </build>
        </profile>
        <profile>
            <id>source</id>
            <build>
                <plugins>
                    <!-- 生成sources源码包的插件 -->
                    <plugin>
                        <artifactId>maven-source-plugin</artifactId>
                        <configuration>
                            <attach>true</attach>
                        </configuration>
                        <executions>
                            <execution>
                                <id>attach-source</id>
                                <goals>
                                    <goal>jar-no-fork</goal>
                                </goals>
                                <phase>package</phase>
                            </execution>
                        </executions>
                    </plugin>
                </plugins>
            </build>
        </profile>
    </profiles>