maven文档注释打包

吴书松
吴书松
发布于 2025-01-06 / 9 阅读
0

maven文档注释打包

在需要打包项目的pom中添加下面配置

<build>
        <plugins>
            <!-- 生成javadoc文档包的插件 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>2.10.2</version>
                <configuration>
                    <!-- 指定Javadoc文档中的字符集 -->
                    <charset>UTF-8</charset> 
                    <!-- 指定Javadoc文档的编码 -->
                    <encoding>UTF-8</encoding> 
                    <docencoding>UTF-8</docencoding>
                    <failOnError>false</failOnError>
                    <aggregate>true</aggregate>
                    <!-- 关闭文档强制校验 -->
                     <additionalparam>-Xdoclint:none</additionalparam>
                </configuration>
                <executions>
                    <execution>
                        <id>attach-javadocs</id>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <!--配置生成源码包-->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-source-plugin</artifactId>
                <version>2.4</version>
                <configuration>
                    <attach>true</attach>
                </configuration>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>jar-no-fork</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

注意,使用了文档注释,所有的文档注释都需要标清楚。如:

不然打包会报错

成功:

失败: