如何在Kotlin文档(KDoc)中添加粗体、斜体、下划线等格式
我在官方的Kotlin参考资料中找到了这一页 然而,我无法找到如何突出显示文档的某些部分,例如,将其标记为斜体或粗体如何在Kotlin文档(KDoc)中添加粗体、斜体、下划线等格式,kotlin,formatting,code-documentation,kdoc,Kotlin,Formatting,Code Documentation,Kdoc,我在官方的Kotlin参考资料中找到了这一页 然而,我无法找到如何突出显示文档的某些部分,例如,将其标记为斜体或粗体 我是来自Java的Kotlin新手,以前只使用过JavaDoc,在那里我们使用和HTML标记来突出文档中的部分。当我写这个问题时,我找到了答案。 愚蠢的我,我正在寻找的链接甚至在问题中 所以,我将为我自己的问题写一个答案,也许将来其他人可以从中获益 文件规定: 内联标记 对于内联标记,KDoc使用常规语法,扩展为支持用于链接到代码中其他元素的速记语法 因此,要强调以下几点: 标
我是来自Java的Kotlin新手,以前只使用过JavaDoc,在那里我们使用
和
HTML标记来突出文档中的部分。当我写这个问题时,我找到了答案。
愚蠢的我,我正在寻找的链接甚至在问题中
所以,我将为我自己的问题写一个答案,也许将来其他人可以从中获益
文件规定:
内联标记
对于内联标记,KDoc使用常规语法,扩展为支持用于链接到代码中其他元素的速记语法
因此,要强调以下几点:
- 标记将星号(
)和下划线(*
)视为强调的指示符。用一个
或*
包装的文本将用HTML
标记包装;双
或*
将用HTML\uu
标记包装。通常,单个星号表示斜体,而双星号表示粗体 - 标题可以以
(h1)、#
(h2)或#
(h3)开头。例如:##
#这是一个H1
- 代码可以用反勾号包装
- 引号以右箭头开头(
) - 降价还支持无序和有序列表