如何为 Kotlin 扩展函数的接收者添加 KDoc 注释（[=10= 中的第一个参数]，Kotlin 中的 `this`）

Question

考虑这个非扩展函数：

fun checkArguments(expression: Boolean) {
    if (!expression) {
        throw IllegalArgumentException()
    }
}

当我在kotlin和java中使用这个函数时，我可以看到它的参数名称：expression.

我也可以将同样的功能写成扩展函数：

fun Boolean.checkArguments() {
    if (!this) {
        throw IllegalArgumentException()
    }
}

当我以这种方式将其编写为扩展函数时，调用它的布尔值的参数名称（函数中的 this 变量，又名接收器）显示为 $this$checkArguments.如何为该参数添加 KDoc 文档注释？使用 @param $this$checkArguments 似乎没有记录它。

Answer 1

您可以使用@receiver来记录扩展函数的接收者。这是 relevant documentation.

例如：

/**
 * @receiver A String that is at least four characters long
 */
fun String.firstFour() = this.substring(0, 4)

How to add a KDoc comment for the receiver of a Kotlin extension function (first parameter in Java, `this` in Kotlin)