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

Question

我想添加这样的评论

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

但是Dokka / Kdoc将方括号内的内容解释为参考。当您在IDE中检查函数的文档或生成文档时，这会导致注释呈现效果很差。如何在Dokka / Kdoc中转义方括号/其他符号？

Answer 1

您可以使用 HTML 转义：

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

应该以 Dokka as 输出range [0..1].，因为[escapes as[和]escapes as ]。

请注意，这在内联代码部分（重音符号 - 之间）内不起作用like this。
对于这种情况，通常使用方括号（[和]），正如半神答案中所建议的那样。

Answer 2

您应该可以使用`符号来做到这一点，如下所示：

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