配置Maven实现Java Jar在IntelliJ中Ctrl+Q自动显示JavaDoc

核心思路 #

Maven通过**分类器（Classifier）**区分主Jar、Sources Jar和Javadoc Jar，只要把这三个包都部署到Maven仓库（本地/远程），IntelliJ就能自动关联，无需手动导入文档Jar。

步骤1：配置pom.xml自动生成Sources和Javadoc包 #

在你的自研项目pom.xml中添加以下插件配置，确保编译时自动生成带sources和javadoc分类器的Jar包：

<build>
    <plugins>
        <!-- 生成Sources Jar -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-source-plugin</artifactId>
            <version>3.3.0</version>
            <executions>
                <execution>
                    <id>attach-sources</id>
                    <goals>
                        <goal>jar-no-fork</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
        <!-- 生成Javadoc Jar -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>3.6.3</version>
            <executions>
                <execution>
                    <id>attach-javadocs</id>
                    <goals>
                        <goal>jar</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

步骤2：部署到Maven仓库 #

• 如果只是本地项目复用，执行命令：mvn clean install
  执行后，本地Maven仓库（默认~/.m2/repository）会出现三个文件：
  • 主Jar：your-artifact-id-1.0.0.jar
  • Sources Jar：your-artifact-id-1.0.0-sources.jar
  • Javadoc Jar：your-artifact-id-1.0.0-javadoc.jar
• 如果要共享给团队，部署到私有/远程Maven仓库，执行：mvn clean deploy（需提前配置仓库地址）

步骤3：在引用项目中使用 #

直接在引用项目的pom.xml中添加依赖即可，无需额外配置：

<dependency>
    <groupId>your-group-id</groupId>
    <artifactId>your-artifact-id</artifactId>
    <version>1.0.0</version>
</dependency>

IntelliJ会自动从Maven仓库拉取对应的Sources和Javadoc，按下Ctrl+Q就能直接显示你编写的JavaDoc注释。如果没自动加载，右键依赖 → Download Sources and Documentation即可手动触发。

注意：JavaDoc注释格式修正 #

你示例中的注释写法有问题，每行开头的/*会导致Javadoc解析异常，正确写法应该是：

/**
 * This is the method that is doing ....
 * @return further info
 */
public void bla() { ... }

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