我有一个简单的项目 src/main/java/test/Test.java
package test;
/**
* Class java doc
*/
public class Test
{
/**
* Wrong java doc
*
* @param test
* @return
*/
public int aMethod(int param){
return 0;
}
}
和pom.xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.test</groupId>
<artifactId>test</artifactId>
<version>1.0.0-SNAPSHOT</version>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.0</version>
<configuration>
<source>1.8</source>
<target>1.8</target>
<encoding>UTF-8</encoding>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.0.0</version>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
当使用 oracle-jdk8 (161) 在 Linux 上构建时,由于 javadoc 不正确而失败
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.0.0:jar (attach-javadocs) on project test: MavenReportException: Error while generating Javadoc:
[ERROR] Exit code: 1 - /home/D070061/SAPDevelop/test/src/main/java/test/Test.java:10: error: @param name not found
[ERROR] * @param test
当使用 open-jdk8 (v171) 执行相同操作时,构建成功
我使用 sudo update-alternatives --config java
有人知道为什么它在 OpenJDK 上不会失败吗?这是一个错误还是需要一些特殊参数?
最佳答案
看起来 Debian patches javadoc to disable doclint by default ,大概就像一些派生发行版和其他发行版一样。
Maven Javadoc 插件添加了 <doclint>
3.0.0 中的配置项,因此对于该版本及更高版本,您应该能够通过指定例如来重新启用 doclint:
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.1.0</version>
<configuration>
<doclint>all</doclint>
</configuration>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
关于Javadoc 在 Oracle JDK 上失败,但在 OpenJDK 上却失败,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/51245779/