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

Question

我想添加一个类似的注释

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

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

Answer 1

您应该能够使用`symbol来完成，如下所示：

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

但是，使用"symbol"会将介于两者之间的所有内容显示为代码块。

要只使用方括号而不使用内部引用，请使用HTML符号，如@yuvgin答案中的[和]。

Answer 2

您可以使用HTML转义：

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

应该在Dokka中作为range [0..1].输出，因为[作为[转义，而]作为]转义。

请注意，这在内联代码的一部分(在重音符号-like this之间)内不起作用
在这种情况下，通常使用方括号([和])，正如半神的回答中所建议的那样。