如何在 Kotlin 文档 Dokka/Kdoc 中转义符号？

Posted 2023-04-14

【中文标题】如何在 Kotlin 文档 Dokka/Kdoc 中转义符号？

【英文标题】：How to escape symbols in Kotlin documentation Dokka/Kdoc?

【发布时间】：2019-07-01 11:03:22

【问题描述】：

我想添加这样的评论

  /**
   * @param scrollFraction In range [0..1].
   */

但 Dokka/Kdoc 将方括号内的内容解释为参考。当您在 IDE 中检查函数的文档或生成文档时，这会导致 cmets 渲染不良。如何在 Dokka/Kdoc 中转义方括号/其他符号？

【参考方案1】：

你应该可以使用`符号来做到这一点，像这样：

 /**
  * @param scrollFraction In range `[0..1]`.
  */

【讨论】：

这也用代码字体而不是常规字体排版反引号内的内容。因此这个答案解决了问题的问题，同时引入了自己的问题。

【参考方案2】：

你可以使用 html 转义：

 /**
   * @param scrollFraction In range [0..1].
   */

应该在 Dokka 中输出为range [0..1].，因为[ 转义为[ 和] 转义为]。

请注意，这不适用于一段内联代码（在重音之间 - like this）。 对于这种情况，通常使用方括号（[ 和 ]），正如 Demigod's answer 中所建议的那样。