Генерация шаблонов документов котлин

Работая раньше в Android Studio, если перед функцией я поставил / ** и нажал ввод, то я автоматически сгенерировал следующий документ с аннотациями для описания параметров, возвращаемого значения и т. Д.

/**
* @params a
* @return
*/
int f(int a)
{
    return a;
}

Когда я начал работать с Kotlin в Android Studio, я попытался создать аналогичный шаблон, он создает пустой шаблон без возвратов, параметров и т. Д.

   /**
    *
    */
    fun f(a: Int)
    {
       return a
    }

Я установил Dokka и попытался установить его в Android Stuio, но он не работал. Как настроить создание аналогичного шаблона для Kotlin в Android Studio?

1 ответ

Решение

Kotlin и особенно KDoc поощряют другой стиль документации. Как указано в этой дискуссии:

Причина в том, что мы обнаружили, что обращение к именам параметров из текста документации позволяет писать документацию, которая является более сжатой и удобной для чтения по сравнению с традиционным стилем javadoc, где каждый параметр задокументирован в отдельном теге. Поэтому мы не генерируем шаблон с именами параметров по умолчанию. (Д. Джемеров, автор "Котлин в действии")

Вот пример let, которая является частью стандартной библиотеки:

/**
 * Calls the specified function [block] with `this` value as its argument and returns its result.
 */
@kotlin.internal.InlineOnly
public inline fun <T, R> T.let(block: (T) -> R): R
Другие вопросы по тегам