Java + 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

5、关闭严格检查，解决 javadoc 报错

使用 <doclint>none</doclint>

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>

          <!-- 严格语法检查配置，none: 关闭严格检查；syntax: 检查基本语法；html: 只检查 HTML -->
          <doclint>none</doclint>

          <!-- 其他选项 -->
          <show>public</show>
          <nohelp>true</nohelp>
        </configuration>
      </plugin>
    </plugins>
  </build>