kotlin - 如何在 kDoc 中跳过一行

Question

在我的 kDoc 中，我想要段落之间的空行。我该如何做到这一点？（还有一个完整的指南吗？比如如何创建表格、项目符号等？）

Answer 1

对于空行 ，在其前后使用空行（两个空行都是必不可少的）：

Answer 2

kdoc 使用降价，另请参阅kdoc 参考。该参考资料还指出，对于内联标记，他们使用以下markdown，但它看起来并不完全受支持。或者至少 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...

如果您将 a<br />放在那里，它基本上应该添加一个新行，但至少它在 Intellij IDEA 中不起作用。但是，将其放在```-code-comment 中时它起作用了。也许是一个错误……也许是 Intellij IDEA 中的一个功能？如果有人可以玩 Dokka 并为此给出适当的答案，那就太好了，只是想分享我到目前为止所知道的。_{（现在必须离开）}

Answer 3

Dokka确实将空行视为段落分隔符，但忽略了<br>and <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 中的呈现方式：