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

object UrlUtils {

    private const val PARAM = "whatever"

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

}

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



我想要的是:



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

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

最佳答案

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

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

关于kotlin - KDoc常数的引用值,我们在Stack Overflow上找到一个类似的问题:https://stackoverflow.com/questions/57287624/

10-10 16:09