kotlin - 如何在 Kotlin 文档 Dokka/Kdoc 中转义符号?

标签 kotlin kdoc kotlin-dokka

我想添加这样的评论

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

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

最佳答案

您应该可以使用 ` 符号来执行此操作,如下所示:

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

关于kotlin - 如何在 Kotlin 文档 Dokka/Kdoc 中转义符号?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/54571489/

相关文章:

maven - 如何将 gradle 中的 groovy 任务转换为 Gradle Kotlin DSL 以生成 pom.xml?

java - 如何在 Android 中离线运行 Dokka

java - 如何在 Kotlin 数据类中记录属性?

kotlin - ktdoc中如何使用 `@sample`?

java - 在使用 Kotlin 的 Android Studio 3.6.1 中,System.out.println(CustomArrayList) 不会在调试时打印值

java - 你能@Autowired一个@MessageGateway到RestController中吗

android - ConstraintLayout 是否仍然优于 Jetpack Compose 中的嵌套列和行?

android-studio - 在kDoc中使用@link和别名

android - Dokka - 跳过为默认的 android 包生成 javadoc