概述：Maven 提供了 javadoc 插件来执行这个任务。
废话不多说，让我们开始操作吧！！！
第一步：引入插件
在 pom.xml 中配置 javadoc 插件： 在 Maven 项目的 pom.xml 文件中，你需要添加 javadoc 插件的配置。
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.3.0</version>
<configuration>
<!-- 配置插件的其他参数，例如生成文档的目录等 -->
</configuration>
</plugin>
</plugins>
</build>
请确保插件的版本号是你所需的版本。
第二步：编写适当代码
Car类
package org.example;
/**
* This class represents a car.
* It has methods to start and stop the engine.
*/
public class Car {
/**
* Starts the car's engine.
* @param key The key used to start the engine.
*/
public void startEngine(String key) {
System.out.println("Car start");
}
/**
* Stops the car's engine.
*/
public void stopEngine() {
System.out.println("Car stop");
}
}
Main类
package org.example;
/**
* The Main class contains the main method to start the application.
*/
public class Main {
/**
* The main method prints "Hello world!" to the console.
*
* @param args Command line arguments (not used in this example).
*/
public static void main(String[] args) {
System.out.println("Hello world!");
}
}
第三步：运行 Maven 命令生成 JavaDoc
打开终端或命令行界面，导航到你的 Maven 项目根目录，并运行以下 Maven 命令：
mvn javadoc:javadoc
这个命令会触发 javadoc 插件，根据配置生成 JavaDoc 文档。生成的文档通常会存放在 target/site/apidocs/ 目录下。
第四步：查看结果
构建成功
在浏览器上查看
