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

Question

我想添加一个这样的评论

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

但Dokka/Kdoc将方括号内的内容解释为参考。这会导致在IDE中检查函数的文档或生成文档时出现严重的注释。如何在Dokka/Kdoc中避开方括号/其他符号？

Answer 1

您应该能够使用‘符号’来完成它，如下所示：

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

但是，使用‘符号’可以将中间的所有内容显示为代码块。

要使用方括号，不要在内部引用，请使用HTML符号，类似于@yuvgin的答案。

Answer 2

您可以使用HTML转义：

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

应该以range [0..1].的形式输出Dokka，因为[转义为[，]转义为]。

注意，这将不能在内联代码的一部分中工作(在grave重音-like this之间)。

对于这种情况，通常使用方括号(和)，正如Demigod's answer中所建议的那样。