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

【问题标题】：Documenting parameters of a function parameter in Kotlin在 Kotlin 中记录函数参数的参数
【发布时间】：2017-04-23 18:24:17
【问题描述】：

假设我有一个高阶函数，它注册了某种点击监听器。我可以记录它的用途和传入的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 中出现警告，我想知道是否有更合适的方法去做。

【问题讨论】：

标签： documentation kotlin higher-order-functions

【解决方案1】：

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

【讨论】：