IntelliJ IDEA中Java与Kotlin混合Spring Boot项目JavaDoc生成报错求助

问题描述 #

用IntelliJ IDEA开发的Java、Kotlin混合Spring Boot项目，能正常构建和运行，但生成JavaDoc时，Java类中导入的Kotlin包报错：

error: package xxxx.yyyyyy.zzzzz does not exist

解决方案 #

根据项目使用的构建工具，分别调整配置：

1. Maven项目配置

需要确保Kotlin代码先编译，同时让JavaDoc插件能识别Kotlin编译后的class文件，在pom.xml中添加/修改以下插件配置：

<build>
    <plugins>
        <!-- 配置Kotlin编译插件，优先编译Kotlin代码 -->
        <plugin>
            <groupId>org.jetbrains.kotlin</groupId>
            <artifactId>kotlin-maven-plugin</artifactId>
            <version>${kotlin.version}</version>
            <executions>
                <execution>
                    <id>compile</id>
                    <phase>compile</phase>
                    <goals>
                        <goal>compile</goal>
                    </goals>
                </execution>
                <execution>
                    <id>test-compile</id>
                    <phase>test-compile</phase>
                    <goals>
                        <goal>test-compile</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <jvmTarget>${java.version}</jvmTarget>
            </configuration>
        </plugin>
        <!-- 配置JavaDoc插件，引入Kotlin编译输出路径 -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>3.5.0</version>
            <configuration>
                <classpathScope>compile</classpathScope>
                <additionalparam>-classpath ${project.build.outputDirectory}</additionalparam>
            </configuration>
        </plugin>
    </plugins>
</build>

配置完成后，执行命令生成JavaDoc：

mvn javadoc:javadoc

2. Gradle项目配置

在build.gradle（或build.gradle.kts）中调整javadoc任务，让它依赖Kotlin编译任务并引入Kotlin输出目录：

tasks.withType(Javadoc) {
    // 确保先完成Kotlin代码编译
    dependsOn tasks.compileKotlin
    // 将Kotlin编译后的class文件加入JavaDoc的类路径
    classpath += files(tasks.compileKotlin.outputs.files)
}

执行命令生成JavaDoc：

# Linux/Mac
./gradlew javadoc

# Windows
gradlew.bat javadoc

3. IntelliJ IDEA直接生成JavaDoc的操作调整

如果直接用IDEA的GUI生成JavaDoc：

• 打开Tools -> Generate JavaDoc对话框
• 在「Other command line arguments」输入框中添加：-classpath $MODULE_DIR$/build/classes/kotlin/main（Maven项目替换为$MODULE_DIR$/target/classes，根据实际编译路径调整）
• 确认生成范围包含项目所有模块，点击「OK」生成

额外注意点 #

• 检查Kotlin类的访问修饰符：如果Kotlin类默认是internal，Java无法访问，需要改为public（不过项目能正常运行的话大概率不是这个问题）
• 确保IDEA的项目结构配置中，Kotlin的编译输出目录已正确设置

内容的提问来源于stack exchange，提问作者Sergio B.