我想添加这样的评论
/**
* @param scrollFraction In range [0..1].
*/
但是 Dokka/Kdoc 将方括号内的内容解释为参考。当您在 IDE 中检查函数的文档或生成文档时，这会导致呈现错误的注释。如何在 Dokka/Kdoc 中转义方括号/其他符号？
问问题
670 次
2 回答
5
您应该可以使用 ` 符号来执行此操作，如下所示：
/**
* @param scrollFraction In range `[0..1]`.
*/
于 2019-02-07T11:44:37.960 回答
5
您可以使用 HTML 转义：
/**
* @param scrollFraction In range [0..1].
*/
应该在 Dokka 中输出 as range [0..1].，因为[escapes as[和]escapes as ]。
请注意，这不适用于一段内联代码（在重音 - 之间like this）。
对于这种情况，通常使用方括号（[ 和 ]），正如半神回答中所建议的那样。
于 2019-02-07T12:00:16.013 回答