KDoc 常量的参考值

use*_*815 6 kotlin kdoc kotlin-dokka

object我的项目中有类似以下内容

object UrlUtils {

    private const val PARAM = "whatever"

    /**
     * Method that appends the [PARAM] parameter to the url
     */
    fun appendParameter(url: String) {
        // ...
    }

}
Run Code Online (Sandbox Code Playgroud)

正如您所看到的,我想PARAM在方法的 KDoc 注释中引用字段的值appendParameter,但是在查看注释时,我看不到实际值,而只看到字段的名称。

将 PARAM 参数附加到 url 的方法

我想要的是:

将whatever参数附加到url的方法

在 Javadoc 中,这是通过使用来实现的{@value PARAM},但在 KDoc 中似乎没有类似的东西。甚至自动代码转换器也保留旧的 Javadoc。

所以我的问题是:我是否遗漏了什么,或者 KDoc/Dokka 是否缺少此功能?

Bas*_*ass 5

目前,{@value}KDoc 不支持标签。

最近请求此问题的是#488,因此您可以对其进行投票和/或评论。