如何在KDoc注释中正确链接Kotlin顶层函数?
KDoc中链接顶层函数的正确方式
在Kotlin中,顶层函数的KDoc链接不需要依赖编译后自动生成的FooKt类名,以下是几种可行的正确写法:
同包内引用
如果你的KDoc所在代码与bar()函数处于同一个包(com.example),直接写函数名即可:
/** * Used by [bar] */
跨包引用
跨包场景下,直接使用包名+函数名的全限定格式,无需添加自动生成的类后缀:
/** * Used by [com.example.bar] */
导入后简化引用
如果已经通过import com.example.bar导入了该顶层函数,同样可以直接使用[bar]进行链接,效果和同包场景一致。
若按上述写法操作后,IntelliJ IDEA仍提示无法解析,可尝试通过File → Invalidate Caches... → Invalidate and Restart刷新IDE缓存,大概率能解决识别问题。
内容的提问来源于stack exchange,提问作者Jakub Bochenski
相关产品推荐
相关产品推荐

