使用javadoc生成API文档
文章目录
一、使用idea工具辅助生成javadoc文档
zh_CN
-encoding utf-8 -charset utf-8 -tag date:a:"日期:" -doctitle "示例" -windowtitle "示例"
idea 开发工具
Tools->Generate JavaDoc
二、使用maven-javadoc-plugin辅助生成javadoc文档
1.单模块项目
<profiles>
<profile>
<id>javadoc</id>
<build>
<plugins>
<!-- 生成javadoc文档包的插件 -->
<!-- https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html -->
<!-- https://maven.apache.org/plugins/maven-javadoc-plugin/ -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<encoding>utf-8</encoding>
<docencoding>utf-8</docencoding>
<charset>utf-8</charset>
<tags>
<tag>
<name>date</name>
<placement>a</placement>
<head>日期:</head>
</tag>
</tags>
<doctitle>示例</doctitle>
<windowtitle>示例</windowtitle>
<locale>zh_CN</locale>
<!-- 可选值 all none accessibility,html,missing,reference,syntax, - 代表排除某个group -->
<doclint>all,-missing</doclint>
</configuration>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
<profile>
<id>source</id>
<build>
<plugins>
<!-- 生成sources源码包的插件 -->
<plugin>
<artifactId>maven-source-plugin</artifactId>
<configuration>
<attach>true</attach>
</configuration>
<executions>
<execution>
<id>attach-source</id>
<goals>
<goal>jar-no-fork</goal>
</goals>
<phase>package</phase>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
</profiles>
若生成javadoc过程中，控制台出现乱码，可尝试以下操作:
-Dfile.encoding=GBK
2.多模块项目
<profiles>
<profile>
<id>javadoc</id>
<build>
<plugins>
<!-- 生成javadoc文档包的插件 -->
<!-- https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html -->
<!-- https://maven.apache.org/plugins/maven-javadoc-plugin/ -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<!-- 是否传递给子模块 -->
<inherited>false</inherited>
<configuration>
<encoding>utf-8</encoding>
<docencoding>utf-8</docencoding>
<charset>utf-8</charset>
<tags>
<tag>
<name>date</name>
<placement>a</placement>
<head>日期:</head>
</tag>
</tags>
<doctitle>示例</doctitle>
<windowtitle>示例</windowtitle>
<locale>zh_CN</locale>
<!-- 可选值 all none accessibility,html,missing,reference,syntax, - 代表排除某个group -->
<doclint>all,-missing</doclint>
<!-- 多个值之间使用:分割;可使用通配符* -->
<excludePackageNames>com.example.package1:com.example.package1.*</excludePackageNames>
</configuration>
<executions>
<execution>
<id>aggregate</id>
<goals>
<goal>aggregate-jar</goal>
</goals>
<phase>package</phase>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
<profile>
<id>source</id>
<build>
<plugins>
<!-- 生成sources源码包的插件 -->
<plugin>
<artifactId>maven-source-plugin</artifactId>
<configuration>
<attach>true</attach>
</configuration>
<executions>
<execution>
<id>attach-source</id>
<goals>
<goal>jar-no-fork</goal>
</goals>
<phase>package</phase>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
</profiles>
建议启用
use plugin registry
3.生成javadoc
多模块项目root下，执行生命周期阶段
clean和package
mvn clean package