我正在尝试为我的项目生成 Javadoc HTML 文件。我通过 Maven Javadoc 插件 (maven-javadoc-plugin) 生成它们。我正在使用 Maven 2.2.1。生成的所有内容都包含所有正确的信息,但 HTML 看起来很糟糕。太糟糕了,我不想那样发布。这是一个屏幕截图:
(注意:是的,我看到“JavaScript 在您的浏览器上被禁用”消息。即使我点击 IE 8 关于 Activity 内容的警告并启用它,也没有任何区别)
有各种不必要的换行符,基本格式也很垃圾。我错过了什么吗?如果我将鼠标悬停在一个类或方法上并看到弹出的 Javadoc 面板,我希望看到生成的 Javadoc 看起来与我在 Eclipse 中看到的类似。
我已经尝试在我的 POM 文件中添加设置,但我真的不知道在配置 Javadoc 生成器时我在做什么。这是我目前拥有的(在 <reporting>
元素内):
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.9</version>
<configuration>
<javadocExecutable>C:\Java\jdk1.7.0_05\bin\javadoc.exe</javadocExecutable>
<javadocVersion>1.7</javadocVersion>
<locale>en_US</locale>
<show>package</show>
<verbose />
</configuration>
</plugin>
有什么建议吗?
更新:
Paulius 提供的解决方案非常有效。我从 <reporting>
中删除了上面的部分部分,因为这完全没有必要。我添加了新的 <plugin>
他在下面指定的元素。我的 POM 文件现在包含这个新 block :
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.8.1</version>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
...
</plugins>
</build>
这是固定输出的样子:
最佳答案
尝试从 reporting
部分删除 maven-javadoc-plugin
。如果您使用的是 Maven 3,则报告部分已弃用,应将其删除。
尝试添加以下内容:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.8.1</version>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
到您的 Maven plugins
部分并运行它。我正在像这样使用 maven-javadoc-plugin
,它会生成正常的 javadoc。
希望这对您有所帮助。
关于java - 为什么我生成的 Javadoc 看起来很糟糕?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/13049548/