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

How to add formatting such as bold, italic, underscore, etc. to Kotlin documenation (KDoc)

我在 Kotlin 官方参考资料中找到了 Documenting Kotlin Code 页面。

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

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

当我写这个问题时,我找到了答案。 愚蠢的我,我正在寻找的 link 甚至是问题中的 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.
  • Headers 可以以 # (h1)、## (h2) 或 ### (h3) 开头。例如:# This is an H1
  • 代码可以用反引号包裹
  • 引号以右箭头开头 (>)
  • Markdown 还支持无序列表和有序列表
  • ... and more