使用 Tomcat 的 Maven 项目中 JavaDoc 文件的最佳位置是什么？

Question

我经常使用 Travis CI 将 Maven 项目部署到 Tomcat 服务器。我的项目是一个网络应用程序，所以我配置了我的 pom.xml 来构建一个 WAR 文件，而不是一个 JAR：

...
<packaging>war</packaging>
...

使用 Maven，我可以为我的项目生成一个包含所有 JavaDoc 文件的目录； Maven 将它们放在 target/site/apidocs 目录中。但是，当我部署我的项目时，Travis 不执行任何 mvn site 阶段，所以我的 JavaDocs 没有在服务器上。

我应该编辑我的 pom.xml 以便 Maven 将 JavaDoc 文件放在 src 目录中的某处（而不是 target）还是有办法将 JavaDoc 文件打包在一起使用 WAR 文件？我想我可以在 src/main/webapp/ 中创建一个 docs/ 目录。具体来说：是 "good practice" 在 src 而不是 target 中生成我的 JavaDoc？如果没有，我怎样才能拥有包含我的 JavaDoc 的 WAR 文件？

您认为最好的做法是什么？

我已经知道如何生成包含我的 JavaDoc 文件的独立 JAR（请参阅 here），但这不是我要找的。

Answer 1

使用站点插件https://maven.apache.org/plugins/maven-site-plugin/ and the javdoc plugin https://maven.apache.org/plugins/maven-javadoc-plugin/usage.html。

将以下内容添加到您的 pom.xml

   <reporting>
                <plugins>
                        <plugin>
                                <groupId>org.apache.maven.plugins</groupId>
                                <artifactId>maven-javadoc-plugin</artifactId>
                                <configuration>
                                        <links>
                                                <link>http://commons.apache.org/lang/api</link>
                                                <link>http://java.sun.com/j2se/1.5.0/docs/api</link>
                                                <link>http://this-one-will-not-work</link>
                                        </links>
                                </configuration>
                        </plugin>
                </plugins>
    </reporting>

然后 mvn site:site 您的文档将在 target/site 您也可以部署它。

使用 Tomcat 的 Maven 项目中 JavaDoc 文件的最佳位置是什么？

What is the best place for JavaDoc files in a Maven project using Tomcat?

tomcat

javadoc

pom.xml

maven