2016-06-24 3 views
9

Как вы создаете комментарии для своих методов/классов? Просто наберите:Создание метода Kotlin/комментарии к классу

/** 

И толкая вводите, кажется, не работает в IntelliJ IDEA 2016.1.3

Похоже Dokka вытеснила KDoc, но почему не существует никакой поддержки в IntelliJ? Или я чего-то не хватает?

Разъяснение: при вводе/** + Enter, это получает генерируется:

/** 
* 
*/ 

Но я задаюсь вопросом, почему поколение @param и другие не добавляются (например, IntelliJ делает для Java) , Эти аннотации используются для документирования Котлин кода, а также (https://kotlinlang.org/docs/reference/kotlin-doc.html)

+0

'/' + '*' + '*' + 'ENTER' генерирует'/** \ n * \ n */'для меня в 2016.1.3. У вас может возникнуть проблема с плагином? – mfulton26

+1

Привет, извините, я должен уточнить, что это сгенерирует это, но он не генерирует здесь @ params/@ return: https://kotlinlang.org/docs/reference/kotlin-doc.html Редактировать: добавлено разъяснение вопрос. – DenEwout

ответ

8

В @param и другие теги не создаются, так как рекомендуется стиль документации Котлин является для обозначения имен параметров из док текста комментария, используя синтаксис [foo], а не для их документирования с использованием явных @param тегов. Вы можете проверить Kotlin standard library documentation, чтобы узнать, как этот стиль используется.

+0

Тогда почему на странице [Documenting Kotlin Code] (https://kotlinlang.org/docs/reference/kotlin-doc.html) есть список всех доступных тегов? Я что-то здесь не хватает? – Daksh

+0

Теги доступны и поддерживаются, но не используются _recommended_ для использования. – yole

+0

Мне нужно попросить вас связать меня с документацией, которая описывает процесс документации как можно более подробно. Благодаря! Поскольку, взглянув на ссылку, опубликованную в моем предыдущем комментарии, мне показалось, что это то, что рекомендует официальная документация Kotlin. – Daksh