Maven 多模块以及单模块生成Javadoc配置，同时识别基础markdown语法

最新推荐文章于 2026-01-03 10:44:21 发布

原创最新推荐文章于 2026-01-03 10:44:21 发布 · 1.9k 阅读

1 ·

本内容遵循CC 4.0 BY-SA版权协议

maven 专栏收录该内容

3 篇文章

订阅专栏

本文介绍了如何在Maven项目中配置多模块和单模块以生成Javadoc，并详细讲解了如何在生成过程中同时支持基础的Markdown语法。对于多模块项目，只需在父pom.xml进行配置，使用`mvn javadoc:aggregate`命令即可完成聚合生成。

父pom.xml配置，子无需配置

<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.platform</groupId>
  <artifactId>0001001</artifactId>
  <version>1.0.0-SNAPSHOT</version>
  <packaging>pom</packaging>
  <modules>
  	<module>0001001M</module>
  	<module>0001001D</module>
  	<module>0001001S</module>
  	<module>0001001I</module>
  	<module>0001001P</module>
  </modules>
  
<build>
  	<plugins>
  		<plugin>
			<groupId>org.apache.maven.plugins</groupId>
			<artifactId>maven-javadoc-plugin</artifactId>
			<version>2.9.1</version>
			<configuration>
		        <aggregate>true</aggregate><!--多模块时配置为true-->
		        <doclet>ch.raffael.doclets.pegdown.PegdownDoclet</doclet>
		        <docletArtifact>
		          <groupId>ch.raffael.pegdown-doclet</groupId>
		          <artifactId>pegdown-doclet</artifactId>
		          <version>1.3</version>
		        </docletArtifact>
		        <useStandardDocletOptions>true</useStandardDocletOptions>
				<charset>UTF-8</charset>
				<encoding>UTF-8</encoding>
				<docencoding>UTF-8</docencoding>
			</configuration>
			<executions>
				<execution>
					<phase>package</phase>
					<goals>
						<goal>javadoc</goal>
					</goals>
				</execution>
			</executions>
		</plugin>
  	</plugins>
  </build>
</project>

单模块：mvn javadoc:javadoc

多模块：mvn javadoc:aggregate