【问题标题】:How to escape symbols in Kotlin documentation Dokka/Kdoc?如何在 Kotlin 文档 Dokka/Kdoc 中转义符号?
【发布时间】:2019-07-01 11:03:22
【问题描述】:

我想添加这样的评论

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

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

【问题讨论】:

    标签: kotlin kdoc kotlin-dokka


    【解决方案1】:

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

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

    【讨论】:

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

    你可以使用 HTML 转义:

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

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

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

    【讨论】:

      猜你喜欢
      • 2015-04-16
      • 2022-01-09
      • 2019-09-21
      • 2018-08-02
      • 2020-11-09
      • 2016-06-17
      • 2020-12-13
      • 2019-04-24
      • 1970-01-01
      相关资源
      最近更新 更多