在 Kotlin 中记录函数参数的参数

Question

假设我有一个高阶函数，它注册了某种点击侦听器。我可以记录它的用途和传入的 listener 参数，如下所示：

/**
 * Adds a [listener] that's called when the item is clicked.
 *
 * @param listener The listener to add
 */
fun addClickListener(listener: (count: Int) -> Unit) {
    ...
}

我的问题是，有没有办法记录 listener 的参数？在此示例中为 count。在我的实际用例中，我的监听器中有多个参数。

我注意到 [listener] 文本在我使用此功能的文档视图中是可点击的，但它只显示一个关于它的空对话框。有没有办法以某种方式描述那里的参数？

现在，我在 addClickListener 方法中用 @param 块描述了监听器的参数，但这会导致 IDE 中出现警告，并且我想知道是否有更合适的方法来做到这一点。

Answer 1

从 Kotlin 1.1 开始，没有语法来记录用作函数参数的函数类型的参数或 return 值。有一个open YouTrack issue覆盖这个。

在 Kotlin 中记录函数参数的参数

Documenting parameters of a function parameter in Kotlin

documentation

higher-order-functions

kotlin