如何為 Kotlin 擴展函數的接收者添加 KDoc 注釋（Java 中的第一個參數，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來記錄擴展函數的接收者。 這是相關的文檔。

例如：

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