logo标签列表

如何在Kotlin文档（KDoc）中添加格式，例如加粗、斜体、下划线等。

kotlinformattingcode-documentationkdoc
22

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

然而，我无法找到如何突出文档的特定部分，例如将其标记为斜体或粗体。

我是一名来自Java的新手，之前只使用过JavaDoc，在那里我们使用<i>和<b> HTML标签来突出文档中的部分。

1个回答
35

在写这个问题的时候，我找到了答案。 傻乎乎的我，在问题引用的页面上甚至找到了我要找的链接。

所以，我将自己的问题写成答案，可能其他人将来也能从中受益。

文档内容如下:

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

因此，为了突出Markdown的一些重点:

  • Markdown将星号(* )和下划线(_)视为强调的指示符。包含一个*或者_的文字将被包装在HTML 标签中;两个星号(*)或下划线(_)将被包装在HTML 标签中。通常，单个星号产生斜体，而双星号产生粗体。
  • 标题可以以#(h1)，##(h2)或###(h3)开头。例如：# 这是一个H1
  • 代码可以用反引号括起来
  • 引用以右箭头（>）开头
  • Markdown 还支持无序和有序列表
  • ...以及更多
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接