如何在Kotlin文档(KDoc)中添加粗体,斜体,下划线等格式

Question

我在Kotlin官方参考中找到了记录Kotlin代码的页面.

然而,我无法找到如何突出文档的某些部分,例如,将其标记为斜体或粗体.

我是Kotlin的新手,来自Java,以前只使用过我们使用的JavaDoc <i>和<b>HTML标签来突出文档中的部分.

Answer 1

当我写这个问题时,我找到了答案.傻我,我正在寻找的链接就在我在问题中引用的页面上.

所以,我会回答一下我自己的问题,也许其他人可以在将来从中获利.

文件说明:

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

因此,要强调Markdown的几点:

• Markdown将星号(*)和下划线(_)视为重点的指标.用一个包装的文本*或_用HTML <em>标签包装的文本; double *的或者_将用HTML <strong>标签包装.通常,单个星号导致斜体,而双星号导致粗体.
• 标题可以用#(h1),##(h2)或###(h3)开头.例如:# This is an H1
• 代码可以包含在反引号中
• 引号以右箭头开头(>)
• Markdown还支持无序和有序列表
• ... 和更多