Maven项目java-doc文档生成和源码打包pom.xml配置

最新推荐文章于 2024-04-18 11:48:34 发布

进修的CODER

最新推荐文章于 2024-04-18 11:48:34 发布

阅读量1.3k

点赞数

分类专栏： Maven 文章标签： maven pom java

本文链接：https://blog.csdn.net/lovequanquqn/article/details/82258176

版权

Maven 专栏收录该内容

8 篇文章

订阅专栏

<properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
        <maven.doc.encoding>UTF-8</maven.doc.encoding>
</properties>

 <build>
        <plugins>
            <!-- 文档 插件 -->
            <!-- https://mvnrepository.com/artifact/org.apache.maven.plugins/maven-javadoc-plugin -->
            <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>

            <!-- 打包源码插件 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-source-plugin</artifactId>
                <version>3.0.1</version>
                <configuration>
                    <attach>true</attach>
                </configuration>
                <executions>
                    <execution>
                        <phase>compile</phase>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>