将 Javadoc 生成绑定到 mvn 包

Question

我是 Maven 的新手（第一次大学作业），我正在尽我所能寻求帮助。

我应该配置 Maven 以便编译，创建一个 JAR 文件，并在使用 mvn package 命令时生成 javadoc。

我已经尝试将 javadoc 目标添加到 pom.xml 文件，但是在使用 package 目标时似乎没有任何东西强制生成 javadoc。

你们中有人知道是否可以这样做吗？如果是这样，如何？

编辑：我尝试了以下解决方案，在阅读了更多文档之后，我想我要做的是将 mvn javadoc:javadoc 执行绑定到 package 阶段。

（如果关于这个确切问题的文档在其他地方，我很乐意删除这个问题，但我还没有找到）

pom.xml 文件：

    <?xml version="1.0" encoding="UTF-8"?>

<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>coo</groupId>
  <artifactId>TP0</artifactId>
  <version>1.1</version>

  <name>TP0</name>
  <!-- FIXME change it to the project's website -->
  <url>https://www.boredbutton.com/</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
  </properties>

  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.11</version>
      <scope>test</scope>
    </dependency>
  </dependencies>

  <build>
    <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
      <plugins>
        <!-- clean lifecycle, see https://maven.apache.org/ref/current/maven-core/lifecycles.html#clean_Lifecycle -->
        <plugin>
          <artifactId>maven-clean-plugin</artifactId>
          <version>3.1.0</version>
        </plugin>
        <!-- default lifecycle, jar packaging: see https://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_jar_packaging -->
        <plugin>
          <artifactId>maven-resources-plugin</artifactId>
          <version>3.0.2</version>
        </plugin>
        <!-- Javadoc -->
        <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-javadoc-plugin</artifactId>
           <version>3.1.1</version>
           <configuration>
             <reportOutputDirectory>${project.build.directory}/docs</reportOutputDirectory>
             <destDir>docs</destDir>
             <nohelp>true</nohelp>
             <!-- <additionalOptions>-html5</additionalOptions> -->
           </configuration>
        </plugin>
        <plugin>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>3.8.0</version>
        </plugin>
        <plugin>
          <artifactId>maven-surefire-plugin</artifactId>
          <version>2.22.1</version>
        </plugin>
        <plugin>
          <artifactId>maven-jar-plugin</artifactId>
          <version>3.0.2</version>
      <configuration>
            <archive>
              <manifest>
            <mainClass>student.MainStudent</mainClass>
              </manifest>
            </archive>
      </configuration>
        </plugin>
        <plugin>
          <artifactId>maven-install-plugin</artifactId>
          <version>2.5.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-deploy-plugin</artifactId>
          <version>2.8.2</version>
        </plugin>
        <!-- site lifecycle, see https://maven.apache.org/ref/current/maven-core/lifecycles.html#site_Lifecycle -->
        <plugin>
          <artifactId>maven-site-plugin</artifactId>
          <version>3.7.1</version>
        </plugin>
        <plugin>
          <artifactId>maven-project-info-reports-plugin</artifactId>
          <version>3.0.0</version>
        </plugin>
      </plugins>
    </pluginManagement>
  </build>
</project>

Answer 1

您必须配置目标和阶段：

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-site-plugin</artifactId>
            <version>3.8.2</version>
        </plugin>
          <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>3.1.1</version>
            <executions>
                <execution>
                    <goals>
                        <goal>javadoc</goal>
                    </goals>
                    <id>execution1</id>
                    <phase>package</phase>
                </execution>
            </executions>
          </plugin> 
        </plugins>
</build>

将 Javadoc 生成绑定到 mvn 包

Binding Javadoc generation to mvn package

java

javadoc

maven

maven-javadoc-plugin