方法文档中的 Kotlin 静态字段值？

Question

这个问题在这里已经有了答案:





Reference value of constant with KDoc

(1 个回答)


2年前关闭。




我想知道是否有可能将类的静态字段的值包含到类方法的文档中。

我们可以通过方括号链接类成员和参数:

/**
 * Sets the title of the notification dialog using [title]
 *
 * The maximum title length allowed is [MAX_TITLE_LENGTH]
 */
fun setTitle(title: String): NotificationDialog.Builder {
    if(title.length <= MAX_TITLE_LENGTH)
        mTitle = title
    else
        mTitle = title.substring(0, MAX_TITLE_LENGTH)

    return this
}

目标

但我想要 MAX_TITLE_LENGTH 的值在方法文档中，而不是指向其名称的链接。

为了完整起见，这是我的类定义:

class Builder(val context: Context) {
    private var mTitle = ""

    /**
     * Sets the title of the notification dialog using [title]
     *
     * The maximum title length allowed is [MAX_TITLE_LENGTH]
     */
    fun setTitle(title: String): NotificationDialog.Builder {
        if(title.length <= MAX_TITLE_LENGTH)
            mTitle = title
        else
            mTitle = title.substring(0, MAX_TITLE_LENGTH)

        return this
    }

    fun build(): NotificationDialog {
        return NotificationDialog(context, mTitle)
    }

    companion object {
        private const val MAX_TITLE_LENGTH = 20
    }
}

提前致谢。

Answer 1

没有这样的，因为 KDoc 是基于标记语言的。取而代之的是，使用方括号允许您在类的属性之间进行链接。在此处查看更多信息:https://kotlinlang.org/docs/reference/kotlin-doc.html#inline-markup