【问题标题】:How to add formatting such as bold, italic, underscore, etc. to Kotlin documenation (KDoc)如何在 Kotlin 文档 (KDoc) 中添加粗体、斜体、下划线等格式
【发布时间】:2019-04-24 01:56:54
【问题描述】:

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

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

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

【问题讨论】:

    标签: kotlin formatting code-documentation kdoc


    【解决方案1】:

    当我写下这个问题时,我找到了答案。 愚蠢的我,我正在寻找的链接甚至是问题中的on the page I referenced

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

    文档说明:

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

    所以,强调Markdown的几点:

    • Markdown 将星号 (*) 和下划线 (_) 视为强调的指标。使用*_ 包裹的文本将使用HTML <em> 标签包裹;双 *_ 将用 HTML <strong> 标签包装。通常,单个星号的结果是 italic,而双星号的结果是 bold
    • 标头可以以# (h1)、## (h2) 或### (h3) 开头。例如:# This is an H1
    • 代码可以用反引号括起来
    • 引用以右箭头开头 (>)
    • Markdown 还支持无序列表和有序列表
    • ... and more

    【讨论】:

      猜你喜欢
      • 2020-01-25
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2011-03-03
      • 1970-01-01
      • 2013-11-06
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多