如何为供Java调用的Kotlin文件中的类添加可识别注释？

咱们先拆解你遇到的两个核心问题：一是Java里看似“找不到”Kotlin定义的Utils类，二是即使能调用也看不到类注释。下面一步步来解决：

1. 先让Java能正确识别你的Utils类 #

如果你的Utils是Kotlin顶级类（直接写在xxx.kt文件中，没有嵌套在其他类里），默认情况下Java会把整个xxx.kt文件编译成名为XxxKt的类（首字母大写+后缀Kt）。这时候Java里访问会有点别扭，甚至IDE会提示“找不到类”，咱们可以给文件加@file:JvmName注解，指定Java里的类名，去掉烦人的Kt后缀：

// 一定要放在xxx.kt文件的最顶部，package声明之前
@file:JvmName("Utils")
package com.your.package

// 接下来写你的Utils类

这样Java里就能像引用普通Java类一样直接用Utils，不会再出现“类不存在”的提示了。

如果你的Utils是嵌套类或者单例object，还要注意：

• 单例object在Java里默认通过Utils.INSTANCE访问，要是想直接调用方法，给方法加@JvmStatic注解
• 嵌套类如果想让Java直接访问，要去掉inner修饰符（Kotlin嵌套类默认是静态的，加了inner才会变成非静态内部类）

2. 让注释能被Java的IDE和Javadoc识别 #

Kotlin的普通注释（// 或 /* ... */）不会被转换成Java能识别的文档信息，必须用KDoc注释（也就是/** ... */格式的块注释）。KDoc的语法和Java的Javadoc类似，IDE会自动把它转换成Java能识别的注释。

给你一个完整的示例：

@file:JvmName("Utils")
package com.your.package

/**
 * 通用工具类，提供字符串处理、数值计算等常用方法
 * @author 你的名字
 * @since 1.0.0
 */
object Utils {
    /**
     * 计算两个整数的和
     * @param a 第一个加数
     * @param b 第二个加数
     * @return 两个整数的和
     */
    @JvmStatic
    fun add(a: Int, b: Int): Int {
        return a + b
    }
}

这样在Java代码里，当你hover到Utils类或者Utils.add()方法上时，IDE就会正常显示你写的注释了。

额外注意事项 #

• 别给Utils加internal修饰符，这个修饰符会让类只能在Kotlin模块内访问，Java里根本看不到
• 如果是Gradle项目，确保开启了Kotlin的文档生成支持（一般默认已经开启，IDE里查看注释不需要额外配置，打包Javadoc的话可以用dokka插件）

总结下来就是两步：用@file:JvmName让Java能直接引用类名，用KDoc格式写注释，这样Java用户就能正常看到Utils类的注释啦！

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