当Javadoc标签不完整时，Maven在Java 8中不工作

2018-06-15 13:14:17

由于我使用Maven，我已经能够在我的本地存储库项目中构建和安装Javadoc标签不完整（例如缺少参数）。

然而，自从我迁移到Java 8（1.8.0-ea-b90）以来，Maven对于缺失的文档标签是绝对严格的，并且当我尝试构建或安装Javadoc不是Javadoc的项目时，显示出与Javadoc问题相关的大量Javadoc错误“完善”。我试图编译并安装在本地存储库中的一些项目是我无法控制的第三方项目。所以，在所有这些项目中修复所有Javadoc的解决方法在我的方案中似乎并不可行。

这是我在我的项目中执行mvn clean package install时看到的输出的一小部分：

[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 9.026s
[INFO] Finished at: Mon Apr 08 21:06:17 CEST 2013
[INFO] Final Memory: 27M/437M
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.9:jar (attach-javadocs) on project jpc: MavenReportException: Error while creating archive:
[ERROR] Exit code: 1 - /Users/sergioc/Documents/workspaces/heal/jpc/src/main/java/org/jpc/engine/prolog/PrologDatabase.java:10: error: @param name not found
[ERROR] * @param terms the terms to assert
[ERROR] ^
[ERROR] /Users/sergioc/Documents/workspaces/heal/jpc/src/main/java/org/jpc/engine/prolog/PrologDatabase.java:11: warning: no description for @return
[ERROR] * @return
[ERROR] ^

Javadoc Maven插件在我的POM中是这样配置的：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.9</version>
    <executions>
        <execution>
            <id>attach-javadocs</id>
            <goals>
                <goal>jar</goal>
            </goals>
        </execution>
    </executions>
</plugin>

正如我之前所说的，如果我回到Java 7，一切工作都很好。也许这是一个与在Java 8中运行的Maven相关的错误？我如何使用Java 8使其工作（即能够构建项目的Javadoc并将其代码安装在本地存储库中）？我已经在OSX中使用Maven 3.0.3和3.0.5进行了测试。

更新：

如果我使用<failOnError>false</failOnError>更改我的Javadoc插件配置（感谢Martin）：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.9</version>
    <executions>
        <execution>
            <id>attach-javadocs</id>
            <goals>
                <goal>jar</goal>
            </goals>
        </execution>
    </executions>
</plugin>

然后该项目安装在我的本地存储库中。但是，Javadoc JAR仍未生成。

我在控制台中看到的输出的一个片段是：

[错误] MavenReportException：创建归档时出错：退出代码：1 - /Users/....java:18：warning：no @param ...命令行为：/ Library / Java / Home / bin / javadoc @options @packages

参考'/ Users / sergioc / Documents / workspaces / heal / minitoolbox / target / apidocs'目录中生成的Javadoc文件。

在org.apache.maven.plugin.javadoc.AbstractJavadocMojo.executeJavadocCommandLine（AbstractJavadocMojo.java:5043）在org.apache.maven.plugin.javadoc.AbstractJavadocMojo.executeReport（AbstractJavadocMojo.java:1990）在org.apache.maven.plugin .javadoc.JavadocJar.execute（JavadocJar.java:181）在org.apache.maven.plugin.DefaultBuildPluginManager.executeMojo（DefaultBuildPluginManager.java:101）在org.apache.maven.lifecycle.internal.MojoExecutor.execute（MojoExecutor.java ：209）在org.apache.maven.lifecycle.internal.MojoExecutor.execute（MojoExecutor.java:153）在org.apache.maven.lifecycle.internal.MojoExecutor.execute（MojoExecutor.java:145）在org.apache。 maven.lifecycle.internal.LifecycleModuleBuilder.buildProject在org.apache.maven.lifecycle.internal.LifecycleStarter（LifecycleModuleBuilder.java:84）在org.apache.maven.lifecycle.internal.LifecycleModuleBuilder.buildProject（LifecycleModuleBuilder.java:59）。在org.apache.maven.lifecycle.internal.Lifecyc的singleThreadedBuild（LifecycleStarter.java:183） lestarter.execute（LifecycleStarter.java:161）at org.apache.maven.DefaultMaven.doExecute（DefaultMaven.java:320）at org.apache.maven.DefaultMaven.execute（DefaultMaven.java:156）at org.apache.maven .cli.MavenCli.execute（MavenCli.java:537）at org.apache.maven.cli.MavenCli.doMain（MavenCli.java:196）at org.apache.maven.cli.MavenCli.main（MavenCli.java:141 ）在sun.reflect.NativeMethodAccessorImpl.invoke0（本机方法）在sun.reflect.NativeMethodAccessorImpl.invoke（NativeMethodAccessorImpl.java:57）在sun.reflect.DelegatingMethodAccessorImpl.invoke（DelegatingMethodAccessorImpl.java:43）在java.lang.reflect中。在org.codehaus.plexus.classworlds.launcher.Launcher.launch（Launcher.java： 230）at org.codehaus.plexus.classworlds.launcher.Launcher.main（Launcher.java:352）org.codehaus.plexus.classworlds.launcher.Launcher.mainWithExitCode（Launcher.java:409）

有关如何构建源代码的任何解决方法，安装项目并在与Java 7一起工作时一步生成Javadoc JAR？

最好的解决方案是修复javadoc错误。如果由于某些原因不可能（例如：自动生成的源代码），那么您可以禁用此检查。

DocLint是Java 8中的一项新功能，概述如下：

提供一种方法来在开发周期的早期检测Javadoc评论中的错误，并且可以轻松链接回源代码。

这是默认启用的，并且会在生成Javadoc之前运行一大堆检查。您需要按照此线程中的说明关闭Java 8。您必须将其添加到您的maven配置中：

<profiles>
  <profile>
    <id>java8-doclint-disabled</id>
    <activation>
      <jdk>[1.8,)</jdk>
    </activation>
    <properties>
      <javadoc.opts>-Xdoclint:none</javadoc.opts>
    </properties>
  </profile>
</profiles>
<build>
  <plugins>
    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.9</version>
        <executions>
            <execution>
                <id>attach-javadocs</id>
                <goals>
                    <goal>jar</goal>
                </goals>
                <configuration>
                    <additionalparam>${javadoc.opts}</additionalparam>
                </configuration>
            </execution>
        </executions>
    </plugin>
    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-site-plugin</artifactId>
        <version>3.3</version>
        <configuration>
          <reportPlugins>
            <plugin>
              <groupId>org.apache.maven.plugins</groupId>
              <artifactId>maven-javadoc-plugin</artifactId>
              <configuration>
                <additionalparam>${javadoc.opts}</additionalparam>
              </configuration>
            </plugin>
          </reportPlugins>
        </configuration>
      </plugin>
   </plugins>
</build>

使用java 8和java 7工作的最简单方法是在构建中使用配置文件：

<profiles>
  <profile>
    <id>doclint-java8-disable</id>
    <activation>
      <jdk>[1.8,)</jdk>
    </activation>

    <build>
      <plugins>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-javadoc-plugin</artifactId>
          <configuration>
            <additionalparam>-Xdoclint:none</additionalparam>
          </configuration>
        </plugin>
      </plugins>
    </build>
  </profile>
</profiles>

不管使用的是什么java版本，下面是我知道忽略doclint警告的最简明的方法。稍加修改就不需要在多个配置文件中重复插件配置。

<profiles>
  <profile>
    <id>doclint-java8-disable</id>
    <activation>
      <jdk>[1.8,)</jdk>
    </activation>
    <properties>
      <javadoc.opts>-Xdoclint:none</javadoc.opts>
    </properties>
  </profile>
</profiles>

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <version>2.9.1</version>
      <executions>
        <execution>
          <id>attach-javadocs</id> <!-- The actual id should be apparent from maven output -->
          <configuration>
            <additionalparam>${javadoc.opts}</additionalparam>
          </configuration>
        </execution>
      </executions>
    </plugin>
    ...
  </plugins>
</build>

在oracle / open jdk 6,7和8上进行测试。

链接地址: http://www.djcxy.com/p/44119.html

上一篇: Maven is not working in Java 8 when Javadoc tags are incomplete

下一篇: can't compile play showcase html