Как мне пропустить строку в kDoc

Question

В моем kDoc я хочу пустую строку между абзацами. Как мне это сделать? (Также есть где-нибудь полное руководство? Например, как создавать таблицы, маркеры и т. Д.?)

Answer 1

Dokka действительно обрабатывает пустые строки как разделители абзацев, но игнорирует <br> и <br/>. Рассмотрим следующий фрагмент KDoc :

/**
 * This is the 1st paragraph.
 *
 * And this is the 2nd one. _IDEA_ indeed ignores any line breaks between
 * paragraphs.
 *
 * # Heading 1
 *
 * This is the text after the heading.
 *
 * ### Heading 3
 *
 * This is the text after the heading.
 * <br>
 * This line is separated with `<br>`.
 * <br/>
 * And this one is separated with `<br/>`.
 */
class C

Вот как это отображается в HTML:

Answer 2

Для пустой строки используйте   с пустыми строками до и после нее (обе пустые строки необходимы):

Answer 3

kdoc использует уценку, см. Также ссылка kdoc . В справке также говорится, что для встроенной разметки они используют следующую уценку , но она не выглядит полностью поддерживаемой. Или, по крайней мере, Intellij IDEA (и, следовательно, вероятно, также Android Studio) не отображает его, как это описывает ссылка на уценку. Может быть, лучше, когда генерируется через Dokka. Еще не пробовал.

Таким образом, если у вас есть заголовки (#) или вы используете пустую строку, это даст вам соответствующий интервал между строками, например ::

# Title (or ### title)

this line has some space before

или просто используя пустую строку:

first line is the summary.

this line is now just written as the second line in your documentation. no space before... but maybe that suffices already...

Если вы поместите туда <br />, он должен добавить новую строку, но по крайней мере это не сработало в Intellij IDEA. Однако это сработало при размещении в ``` -код-комментарии. Может быть, ошибка ... может быть, функция в Intellij IDEA? Было бы хорошо, если бы кто-нибудь мог поиграть с Доккой и дать соответствующий ответ на это, просто хотел бы поделиться тем, что я знаю об этом. _{(сейчас уйти)}