由于 Javadoc 错误，无法构建 Maven 项目？

Question

有没有人遇到过如下类似的 Maven 错误？

由于以下错误，我无法构建我的项目。在我开始编写代码之前，一切正常。

我什至没有处理下面定义的接口，它似乎与 Javadoc 相关？

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.9.1:jar (attach-javadocs) on project jonney-project: MavenReportException: Error while creating archive:

[ERROR] Exit code: 1 - /Users/me/Work/myProject/library/src/main/java/com/me/someInterface.java:45: warning: no @return
[ERROR] public abstract boolean searchForDevce();
[ERROR] ^
[ERROR] /Users/me/Work/myProject/src/main/java/com/me/someInterfaceAgain.java:52: warning: no @return
[ERROR] public abstract boolean selectDevice(int pos);
[ERROR] ^

Answer 1

我猜你切换到 Java 8。在这个版本中，Javadoc 的要求更严格。

你有三个选择：

1. 修复错误
2. 禁用严格检查
3. 构建时跳过 Javadoc

要禁用严格检查，请将其添加到您的 pom.xml

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

要在构建时跳过 Javadoc，请使用：

mvn -Dmaven.javadoc.skip=true verify

Further Information

Answer 2

只需使用属性标签更新您的 pom.xml，如下所示。

<properties>
    <additionalparam>-Xdoclint:none</additionalparam>
</properties>

Answer 3

使用 ma​​ven-javadoc-plugin 版本 3.0.0 <additionalparam/> 已被 <additionalOptions/> 替换。为了将错误减少为警告，这个 pom.xml 条目对我有用：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <executions>
                <execution>
                    <id>attach-javadocs</id>
                    <goals>
                        <goal>jar</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <additionalOptions>
                    <additionalOption>-Xdoclint:none</additionalOption>
                </additionalOptions>
            </configuration>
        </plugin>
    </plugins>
</build>

Answer 4

对于那些在谷歌上搜索此错误的人的更新： 如果项目使用源/目标 8，在 javadoc 配置中添加 8 应该使项目可在 jdk {11、12、13} 上构建：

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
  <source>8</source>
</configuration>
 ...

Answer 5

在使用 3.2.0 版本时，上述选项似乎都不适合我。相反，我注意到failOnError 选项。将此标签值设置为 false 似乎可以让我的构建成功，即使存在 javadoc 错误。

        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>${maven.javadoc.plugin.version}</version>
            <executions>
                <execution>
                    <id>attach-javadocs</id>
                    <goals>
                        <goal>jar</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <failOnError>false</failOnError>
            </configuration>
        </plugin>

这将停止为 maven 项目生成 javadoc jar。在我的情况下这没问题，因为我只想在正在进行的开发过程中构建没有错误。其他选项可能仍然允许在出现错误时生成 javadoc jar。

Answer 6

@turbanoff 从 3.0.0 版开始提到，maven-javadoc-plugin 配置设置 <additionalparam> 已被 <additionalOptions> 取代

所以你的 pom.xml 中的插件定义可以如下所示：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>3.2.0</version>
    <configuration>
        <additionalOptions>-Xdoclint:none</additionalOptions>
    </configuration>
</plugin>

此配置仍会生成警告。所以你可以而且应该在你的代码中修复它们。但它现在将不再破坏 maven 构建。