如何让Maven依赖自动显示类与方法的注释文档

问题核心是你部署到GitHub私有仓库的自研库，只上传了编译后的class文件，没有附带源码（sources.jar）和javadoc文档包，导致IDE没法从仓库获取注释内容。以下是具体解决步骤：

• 在自研库的pom.xml中配置自动生成源码和javadoc包
  添加Maven插件，让打包部署时自动生成并上传源码包和javadoc包到仓库：

  <build>
      <plugins>
          <!-- 生成源码包 -->
          <plugin>
              <groupId>org.apache.maven.plugins</groupId>
              <artifactId>maven-source-plugin</artifactId>
              <version>3.2.1</version>
              <executions>
                  <execution>
                      <id>attach-sources</id>
                      <goals>
                          <goal>jar-no-fork</goal>
                      </goals>
                  </execution>
              </executions>
          </plugin>
          <!-- 生成javadoc包 -->
          <plugin>
              <groupId>org.apache.maven.plugins</groupId>
              <artifactId>maven-javadoc-plugin</artifactId>
              <version>3.4.1</version>
              <executions>
                  <execution>
                      <id>attach-javadocs</id>
                      <goals>
                          <goal>jar</goal>
                      </goals>
                  </execution>
              </executions>
          </plugin>
      </plugins>
  </build>
  

  配置完成后，执行mvn deploy，Maven会将主jar、sources.jar和javadoc.jar一起推送到GitHub私有仓库。

• 配置IntelliJ自动下载源码和文档
  打开IntelliJ的设置，路径为Build, Execution, Deployment -> Build Tools -> Maven -> Importing，勾选以下两个选项：

  • Automatically download Sources
  • Automatically download Documentation
    这样后续新项目引入该依赖时，IDE会自动从仓库拉取源码和注释文档，无需手动指定本地源。

• 补传已部署版本的源码包（如果需要）
  如果之前已经部署过不带源码包的版本，要么重新部署带源码的新版本，要么手动将生成的sources.jar和javadoc.jar上传到GitHub私有仓库对应的版本目录下（推荐用Maven插件自动生成部署，避免手动操作出错）。

内容的提问来源于stack exchange，提问作者Rewwwww