17

我在官方 Kotlin 参考中找到了文档化 Kotlin 代码页面。

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

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

4

1 回答 1

23

当我写下这个问题时，我找到了答案。愚蠢的我，我正在寻找的链接甚至在我在问题中引用的页面上。

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

该文档指出：

内联标记 对于内联标记，KDoc 使用常规Markdown语法，扩展为支持链接到代码中其他元素的简写语法。

所以，要强调Markdown的几点：

  • Markdown 将星号 ( *) 和下划线 ( _) 视为强调的指标。*用一个或_将用 HTML<em>标记包装的文本；double *'s 或_'s 将被 HTML<strong>标签包裹。通常，单个星号导致斜体，而双星号导致粗体。
  • 标头可以以#(h1)、##(h2) 或###(h3) 开头。例如：# This is an H1
  • 代码可以用反引号包裹
  • 引号以右箭头 ( >)开头
  • Markdown 还支持无序列表和有序列表
  • ... 和更多
于 2018-11-21T13:25:45.147 回答