Java8 对 JavaDoc 的语法检查非常严格,我在进行 Maven 编译发布项目到 Maven Center 的过程中,经常产生因为 JavaDoc 编译失败造成发布失败,但是很多情况下,都是一两个 @param 参数没有写全,@return 没有写之类的问题,为此,我觉得非常有必要忽略这些异常。
问题描述
各位应该都知道发布一个 Maven 项目到 Maven 的中央仓库是必须要有 JavaDoc,而我们在使用 Maven JavaDoc plugin 的过程中,一旦出现某些类似于此的问题:
Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.7:jar (attach-javadocs) on project [projectname]: MavenReportException: Error while creating archive:
Exit code: 1 - [path-to-file]:[linenumber]: warning: no description for @param
都会造成整个发布过程失败,解决办法一般是一个一个的把这些 @param 加上去,一两个还好,如果您的项目有成千上万个呢?
解决办法
直接修改 Maven JavaDoc plugin 的配置,忽略这些错误:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.3</version>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
<configuration>
<additionalparam>-Xdoclint:none</additionalparam>
</configuration>
</execution>
</executions>
</plugin>
经过测试,忽略后项目可以正常发布,不会有什么影响。
欢迎来到这里!
我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。
注册 关于