Как добавить форматирование, например полужирный, курсив, подчеркивание и т. Д., В документацию Kotlin (KDoc) - PullRequest
Новая
       47

Как добавить форматирование, например полужирный, курсив, подчеркивание и т. Д., В документацию Kotlin (KDoc)

0 голосов
/ 21 ноября 2018

Я нашел страницу Документирование кода Kotlin в официальном справочнике Kotlin.

Тем не менее, я не смог выяснить, как выделить некоторые части документации,например, пометив его курсивом или полужирным шрифтом.

Я новичок в Kotlin, пришёл из Java и ранее использовал только JavaDoc, где мы использовали теги <i> и <b> HTML для выделения частей вдокументация.

1 Ответ

0 голосов
/ 21 ноября 2018

Когда я писал этот вопрос, я нашел ответ на него.Глупый я, ссылка, которую я искал, даже была на странице, на которую я сослалась в вопросе.

Итак, я напишу ответ на свой вопрос, возможно, кто-то другой может получить прибыль отэто в будущем.

В документации говорится:

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

Итак, выделите несколько пунктов Уценка :

  • Обработка Уценкизвездочки (*) и подчеркивания (_) как индикаторы акцента.Текст, заключенный в один * или _, будет заключен в тег HTML <em>;double * или _ будут заключены в тег HTML <strong>.Обычно одна звездочка дает курсив , а двойная звездочка - полужирный .
  • Заголовки могут быть запущены с # (h1), ## (h2) или ### (h3).Например: # This is an H1
  • Код может быть заключен в обратные кавычки
  • Кавычки начинаются со стрелки вправо (>)
  • Уценка также поддерживает неупорядоченные и упорядоченные списки
  • ... и более
...