代码之家 › 专栏 › 技术社区 › Dmitry Ryadnenko kalyan pvs

如何在Kotlin文档dokka/kdoc中转义符号?

kotlin-dokka kdoc kotlin

1

Dmitry Ryadnenko kalyan pvs · 技术社区 · 7 年前

我想添加这样的评论

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

但dokka/kdoc将方括号内的内容解释为引用。当您在IDE中检查函数的文档或生成文档时,这会导致呈现错误的注释。如何在dokka/kdoc中转义方括号/其他符号?

2 回复 | 直到 7 年前

1

4

Demigod 7 年前

您应该能够使用`符号,如下所示:

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

2

yuvgin 7 年前

可以使用HTML转义:

 /**
   * @param scrollFraction In range &#91;0..1&#93;.
   */

应在Dokka中输出为 range [0..1]. ,因为 [ 逃逸为 [ 和 ] 逃逸为 ] .

注意:这在内联代码的一部分(在重重音之间)内不起作用- like this )
对于这种情况,通常使用方括号([和]),如中建议的那样。 Demigod's answer .