- pom.xml配置
<!--配置属性 -->
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
<java_version>1.8</java_version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<!-- <version>3.5.1</version>-->
<configuration>
<source>${java_version}</source>
<target>${java_version}</target>
<testSource>${java_version}</testSource>
<testTarget>${java_version}</testTarget>
<encoding>${project.build.sourceEncoding}</encoding>
</configuration>
</plugin>
<!--配置生成Javadoc包-->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.0.0</version>
<configuration>
<encoding>${project.build.sourceEncoding}</encoding>
<charset>${project.build.sourceEncoding}</charset>
<docencoding>${project.build.sourceEncoding}</docencoding>
<!--自定义标签,可以不用定义,使用jdk原生的标签-->
<tags>
<tag>
<name>creteTime</name>
<placement>a</placement>
<head>创建日期</head>
</tag>
<tag>
<name>description</name>
<placement>a</placement>
<head>描述</head>
</tag>
<tag>
<name>updateTime</name>
<placement>a</placement>
<head>更新时间</head>
</tag>
<tag>
<name>updateBy</name>
<placement>a</placement>
<head>更新人</head>
</tag>
<tag>
<name>updateDescription</name>
<placement>a</placement>
<head>更新描述</head>
</tag>
</tags>
</configuration>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<!--配置生成源码包-->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>3.0.0</version>
<executions>
<execution>
<id>attach-sources</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
- IDEA中打包 点左上角刷新按钮,重新加载maven项目后,会看到插件里多了javadoc和source插件。
然后install,如果没有报错会在maven仓库和target目录下生成对应的项目jar,javadoc.jar,source.jar三个jar包,如下图:
- 常见错误 如果控制台中文乱码,需要在maven配置中加上环境变量:
JAVA_TOOL_OPTIONS=-Dfile.encoding=UTF-8
4. 效果
生成javadoc和source源码包后,别的项目依赖这个项目时,在引入的类的地方鼠标悬浮上去会有相关注释:
并且可以点进去直接查看源码。