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

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

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

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


kotlin formatting code-documentation kdoc
person Markus Weninger    schedule 21.11.2018    source источник

Ответы (1)


arrow_upward
18
arrow_downward

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

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

В документации указано:

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

Итак, чтобы выделить несколько моментов Markdown:

  • Markdown рассматривает звездочки (*) и символы подчеркивания (_) как индикаторы выделения. Текст, заключенный в один * или _, будет заключен в HTML-тег <em>; двойные * или _ будут заключены в HTML-тег <strong>. Как правило, одна звездочка выделена курсивом, а двойная звездочка — жирным шрифтом.
  • Заголовки могут начинаться с # (h1), ## (h2) или ### (h3). Например: # This is an H1
  • Код можно завернуть в обратные кавычки
  • Цитаты начинаются со стрелки вправо (>)
  • Markdown также поддерживает неупорядоченные и упорядоченные списки.
  • ... и многое другое
person Markus Weninger    schedule 21.11.2018