KDoc常数的参考值

时间:2019-07-31 09:33:31

标签: kotlin kotlin-dokka kdoc

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

object UrlUtils {

    private const val PARAM = "whatever"

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

}

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

  

将PARAM参数附加到网址的方法

我想要什么:

  

将任何参数附加到url的方法

在Javadoc中,这可以通过使用{@value PARAM}来实现,但在KDoc中似乎没有相似之处。甚至自动代码转换器都保留了旧的Javadoc。

所以我的问题是:我缺少什么吗?还是KDoc / Dokka缺少此功能?

1 个答案:

答案 0 :(得分:2)

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

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