IDEA + Spring Boot + javadoc 实例应用

1、添加 javadoc 插件 依赖

pom.xml

<build><plugins><!-- javadoc 插件 --><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-javadoc-plugin</artifactId><version>3.6.3</version><configuration><!-- Java版本 --><source>17</source><!-- 编码配置 --><encoding>UTF-8</encoding><charset>UTF-8</charset><docencoding>UTF-8</docencoding><!-- 文档标题 --><windowtitle>LIMS API文档</windowtitle><doctitle>实验室信息管理系统 API</doctitle><!-- 页眉 --><header><![CDATA[<b>LIMS</b> <br> v1.0]]></header><!-- 页脚，若不设置，默认是：Copyright © 2025. All rights reserved. 设置内容中不能包含 © --><!-- <bottom>信息技术有限公司</bottom> --><!-- 输出路径，使用绝对路径参数，若不设置，默认路径是：\target\site --><reportOutputDirectory>D:\\MyCode\\wylims\\lims-javadoc</reportOutputDirectory><!-- 排除配置 --><excludePackageNames>*.internal.*</excludePackageNames><!-- 其他选项 --><show>public</show><nohelp>true</nohelp></configuration></plugin></plugins></build>

2、打开终端，执行 mvn javadoc:javadoc

 

 虽然有出错，但最终还是能生成相关的 javadoc 文件 

3、生成 javadoc 

4、查看 javadoc，打开 index.html

生成 javadoc 的其他方式：

1、idea 工具生成

 

遇到编码问题，暂时没有找到有效解决方案。

2、打开 Maven 工具，执行 mvn javadoc:javadoc

生成出错，暂时没有找到有效解决方案。