Java子类如何继承Kotlin抽象类的KDoc文档？

这个问题确实挺常见的——Kotlin的KDoc对自己子类友好，但Java子类就没法直接继承查看，我来给你几个靠谱的解决办法：

方法1：在Java子类中手动使用{@inheritDoc}标签 #

这是最直接的办法，在Java子类重写方法时，给方法加上包含{@inheritDoc}的JavaDoc：

public class JavaSubclass extends Something {
    /** {@inheritDoc} */
    @Override
    public void someFun() {
        // 你的实现逻辑
    }
}

这样在IntelliJ里按下Ctrl+Q查看这个方法的文档时，IDE会自动拉取Kotlin父类的KDoc内容显示出来。

方法2：让Kotlin的KDoc兼容JavaDoc语法 #

KDoc本身支持大部分JavaDoc的标签，所以你可以在编写Kotlin父类的KDoc时，尽量用JavaDoc的风格来写（比如用*开头的多行注释，或保留KDoc标题的同时补充JavaDoc风格的描述），这样Java工具和IDE更容易识别：

abstract class Something {
    /**
     * 这是方法的核心功能说明
     *
     * 这里可以补充详细的使用示例、注意事项等
     * @see 相关的类或方法
     */
    abstract fun someFun()
}

这种写法既不影响Kotlin子类查看KDoc，也能让Java子类在IDE中直接识别到文档内容，不需要额外加{@inheritDoc}。

方法3：配置Kotlin编译器生成JavaDoc #

如果你需要生成标准的JavaDoc文档（不仅仅是IDE内查看），可以在构建脚本中配置Kotlin插件生成JavaDoc格式的文档，这样Java项目在引用这个Kotlin类时，文档会被正确识别。

Gradle（Groovy DSL）配置： #

tasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinJavadoc) {
    enabled = true
    // 可选：关闭文档格式检查，避免不必要的报错
    options.addStringOption('Xdoclint:none', '-quiet')
}

Gradle（Kotlin DSL）配置： #

tasks.withType<KotlinJavadoc> {
    enabled = true
    options.addStringOption("Xdoclint:none", "-quiet")
}

执行./gradlew kotlinJavadoc任务后，生成的JavaDoc会包含KDoc的内容，Java子类就能继承到这些文档了。

方法4：确保IntelliJ IDEA的设置正确 #

有时候不是文档的问题，是IDE的配置没开。检查一下你的IntelliJ设置：

• 打开File > Settings > Build, Execution, Deployment > Compiler > Kotlin Compiler，确保Generate JavaDoc comments选项是勾选的（部分版本可能有这个选项）
• 另外，确保你的IntelliJ是最新版本，新版本对Kotlin和Java的文档兼容性支持更好

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