Как следует документировать функции Kotlin typealises?
в Kotlin v1.1+, есть возможность объявления псевдонимы типа, которые предоставляют альтернативные имена для существующих типов. Это особенно полезно для типов функций - например:
typealias OnItemClick = (view: View, position: Int) -> Boolean
и они могут быть задокументированы с комментариями KDoc, как и другие члены:
/**
* Type definition for an action to be preformed when a view in the list has been clicked.
*/
typealias OnItemClick = (view: View, position: Int) -> Boolean
но есть ли конкретный способ документирования параметров и возвращаемого типа типа функции?
веб-сайт Котлин предоставляет информацию о документирование кода Котлина, но не упоминает о typealiases.
как и сами функции, было бы неплохо, если типы функций могут быть описаны следующим образом:
/**
* @param view the view that was clicked
* @param position the layout position from the ViewHolder (see
[ViewHolder.getLayoutPosition])
* @return whether the click was successful
*/
typealias OnItemClick = (view: View, position: Int) -> Boolean
но теги не распознаются в KDoc.
Итак, как должны быть задокументированы параметры и типы возврата?
1 ответов
к сожалению, в настоящее время в KDoc нет специальной поддержки для документирования параметров и возвращаемых значений для typealiases для типов функций, поэтому вам просто нужно описать их как часть документации. Я подал запрос для добавления поддержки.