当 Javadoc 标签不完整时,Maven 无法在 Java 8 中工作

新手上路,请多包涵

自从我使用 Maven 以来,我已经能够在我的本地存储库项目中构建和安装具有不完整 Javadoc 标记(例如,缺少参数)的项目。

但是,自从我迁移到 Java 8 (1.8.0-ea-b90) 之后,Maven 对缺少文档标签绝对严格,并且在我尝试构建或安装一个没有 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:警告:没有@param …命令行是:/Library/Java/Home/bin/javadoc @options @包

请参阅“/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(LifecycleModuleBuilder.java:84) 在 org.apache.maven.lifecycle.internal.LifecycleModuleBuilder.buildProject(LifecycleModuleBuilder.java:59) 在 org.apache.maven.lifecycle.internal.LifecycleStarter。 org.apache.maven.lifecycle.internal.Lifecyc 中的 singleThreadedBuild(LifecycleStarter.java:183) leStarter.execute(LifecycleStarter.java:161) 在 org.apache.maven.DefaultMaven.doExecute(DefaultMaven.java:320) 在 org.apache.maven.DefaultMaven.execute(DefaultMaven.java:156) 在 org.apache.maven .cli.MavenCli.execute(MavenCli.java:537) 在 org.apache.maven.cli.MavenCli.doMain(MavenCli.java:196) 在 org.apache.maven.cli.MavenCli.main(MavenCli.java:141) ) 在 sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) 在 sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:57) 在 sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) 在 java.lang.reflect。 Method.invoke(Method.java:491) 在 org.codehaus.plexus.classworlds.launcher.Launcher.launchEnhanced(Launcher.java:290) 在 org.codehaus.plexus.classworlds.launcher.Launcher.launch(Launcher.java: 230) 在 org.codehaus.plexus.classworlds.launcher.Launcher.mainWithExitCode(Launcher.java:409) 在 org.codehaus.plexus.classworlds.launcher.Launcher.main(Launcher.java:352)

关于如何在使用 Java 7 时一步构建源代码、安装项目和生成 Javadoc JAR 的任何解决方法?

原文由 Sergio 发布,翻译遵循 CC BY-SA 4.0 许可协议

阅读 1.1k
2 个回答

最好的解决方案是修复 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>

对于 maven-javadoc-plugin 3.0.0+: 替换

<additionalparam>-Xdoclint:none</additionalparam>

<doclint>none</doclint>

原文由 Subhas 发布,翻译遵循 CC BY-SA 4.0 许可协议

让事物同时使用 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>

原文由 ankon 发布,翻译遵循 CC BY-SA 3.0 许可协议

撰写回答
你尚未登录,登录后可以
  • 和开发者交流问题的细节
  • 关注并接收问题和回答的更新提醒
  • 参与内容的编辑和改进,让解决方法与时俱进
推荐问题