kotlin - 如何将粗体、斜体、下划线等格式添加到 Kotlin 文档 (KDoc)

Question

我找到了页面 Documenting Kotlin Code 在官方 Kotlin 引用中。

但是，我不知道如何突出显示文档的某些部分，例如，将其标记为斜体或粗体。

我是 Kotlin 的新手，来自 Java，之前只使用过 JavaDoc，我们在其中使用了 <i>和 <b> HTML 标记以突出显示文档中的部分。

Answer 1

当我写下这个问题时，我找到了答案。愚蠢的我，我正在寻找的链接甚至是 on the page I referenced在问题中。

所以，我会为自己的问题写一个答案，也许其他人将来可以从中受益。

文档说明:

Inline Markup For inline markup, KDoc uses the regular Markdown syntax, extended to support a shorthand syntax for linking to other elements in the code.

所以，强调 Markdown 的几点:

• Markdown 将星号 (*) 和下划线 (_) 视为强调指标。用一个 * 包裹的文本或 _将用 HTML <em> 包装标签;双 *的或 _的将用 HTML <strong> 包装标签。通常，单个星号的结果是 italic，而双星号的结果是 bold。
• 标题可以以 # 开头(h1), ## (h2)，或 ### (h3)。例如:# This is an H1
• 代码可以用反引号括起来
• 引号以右箭头开头 (>)
• Markdown 还支持无序列表和有序列表
• ... and more