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

Question

我想添加这样的评论

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

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

Answer 1

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

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

Answer 2

您可以使用HTML转义：

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

在Dokka中的输出应为range [0..1].，因为[的逸出为[，而]的逸出为]。

请注意，这在行内代码部分（在重音符号-like this之间）内无效。
对于此类情况，请按照Demigod's answer的建议使用方括号（[和]）。