Как использовать @link и @code в kotlin kDoc

Я пытаюсь документировать метод и пытаюсь использовать @link и @code как в JavaDoc .

Я знаю, что в kotlin есть kDoc, но я не могу найти их или, по крайней мере, что-то подобное.

@link и @code не существуют в kDoc, но могут быть легко заменены Inline Markup .

от KotlinDoc Linking to Elements

Встроенная разметка

Для встроенной разметки KDoc использует стандартный синтаксис Markdown , расширенный для поддержки сокращенного синтаксиса для привязки к другим элементам кода.

Связывание с элементами

Чтобы связать себя с другим элементом (классом, методом, свойством или параметром), просто поместите его имя в квадратные скобки:

Для этого используйте метод [foo] .

Если вы хотите указать пользовательский ярлык для ссылки, используйте синтаксис стиля ссылки Markdown:

Для этого используйте [this method][foo] . Вы также можете использовать квалифицированные имена в ссылках. Обратите внимание, что в отличие от JavaDoc, квалифицированные имена всегда используют символ точки для разделения компонентов, даже до имени метода:

Используйте [kotlin.reflect.KClass.properties] чтобы перечислять свойства класса. Имена в ссылках разрешаются с использованием тех же правил, что и имя внутри документа, документированного. В частности, это означает, что если вы импортировали имя в текущий файл, вам не нужно полностью его квалифицировать, когда вы используете его в комментарии KDoc.

Обратите внимание, что KDoc не имеет синтаксиса для разрешения перегруженных элементов в ссылках. Поскольку инструмент создания документации Kotlin помещает документацию для всех перегрузок функции на одну и ту же страницу, определение конкретной перегруженной функции не требуется для того, чтобы ссылка работала.

Intereting Posts
Smartcast невозможно, потому что у владельца есть открытый или пользовательский getter Параметр типа класса Kotlin: несоответствие не обнаружено Как издеваться над объектом Котлина с помощью Mockito / PowerMockito? Есть ли способ сделать ящик с тремя состояниями? Требуется генерация. Строка найдена kotlin.String Kotlin добавляет пользовательский прослушиватель для доступа к виджетам на Android SimpleDateFormat обеспечивает неправильный год Как получить доступ и передать параметры модулям Android Instant App Как я могу сказать Kotlin, что массив или коллекция не могут содержать нули? Как использовать @DbEnumValue с Ebean в Котлине? Android Dagger: я не могу предоставить внешний класс без конструктора @Inject RxJava2 Опубликовать Как работать с foldRight () в Котлине? Как создать несколько разделов текстовых просмотров с помощью нескольких касаний? Две функции с различным количеством параметров типа в Котлине