转载

Maven在Java8下忽略Javadoc的编译错误

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>

经过测试，忽略后项目可以正常发布，不会有什么影响。

Author:liumapp

Home-page:http://www.liumapp.com

Email:liumapp.com@gmail.com

没有什么问题是一行代码解决不了的，如果有那就两行，但除了香烟跟姑娘。

原文 http://www.liumapp.com/articles/2018/08/22/1534905949519.html

正文到此结束