maven配置生成java doc文档中文乱码问题解决方案

最新推荐文章于 2025-06-27 13:27:01 发布

原创最新推荐文章于 2025-06-27 13:27:01 发布 · 3k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#maven #pom #java

Maven 专栏收录该内容

8 篇文章

订阅专栏

博客介绍了Java编码及Maven环境变量的配置方法。包括更改环境变量JAVA_TOOL_OPTIONS，设置其值为-Dfile.encoding=UTF - 8；更改Maven环境变量MAVEN_OPTS；还提及了IDEA解决方案和在pom.xml文件中配置，同时提醒更改系统环境变量可能需重启生效。

一、更改环境变量解决

变量名：JAVA_TOOL_OPTIONS

变量值：-Dfile.encoding=UTF-8

二、更改Maven环境变量

环境变量名=变量值：MAVEN_OPTS=-Xms128m -Xmx512m -Dfile.encoding=UTF-8

三、IDEA解决方案

四、pom.xml文件中配置

plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>2.9.1</version>
                <configuration>
                    <aggregate>true</aggregate>
                    <encoding>${maven.doc.encoding}</encoding>
                    <charset>${maven.doc.encoding}</charset>
                    <docencoding>${maven.doc.encoding}</docencoding>
                    <destDir>doc</destDir>
                    <tags>
                        <!--MAVEN_OPTS=-Dfile.encoding=UTF-8;JAVA_TOOL_OPTIONS=-Dfile.encoding=UTF-8-->
                        <tag>
                            <head>描述</head>
                            <name>Description</name>
                            <placement>a</placement>
                        </tag>
                        <tag>
                            <head>return</head>
                            <name>return</name>
                            <placement>a</placement>
                        </tag>
                        <tag>
                            <head>参数</head>
                            <name>param...</name>
                            <placement>a</placement>
                        </tag>
                        <tag>
                            <head>时间</head>
                            <name>date</name>
                            <placement>a</placement>
                        </tag>
                        <tag>
                            <head>时间</head>
                            <name>Date</name>
                            <placement>a</placement>
                        </tag>
                    </tags>
                </configuration>
                <executions>
                    <execution>
                        <id>attach-javadoc</id>
                        <phase>package</phase>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                        <configuration>
                            <!--取消对源码中的doc参数注释等检查-->
                            <additionalparam>-Xdoclint:none</additionalparam>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

NOTE：更改系统环境变量可能需要重启后生效.