如何在Kotlin文档Dokka/Kdoc中转义符号?
我想添加这样的评论如何在Kotlin文档Dokka/Kdoc中转义符号?,kotlin,kdoc,kotlin-dokka,Kotlin,Kdoc,Kotlin Dokka,我想添加这样的评论 /** * @param scrollFraction In range [0..1]. */ 但Dokka/Kdoc将方括号内的内容解释为引用。当您在IDE中检查函数的文档或生成文档时,这会导致糟糕的注释呈现。如何在Dokka/Kdoc中转义方括号/其他符号?您应该能够使用`symbol,如下所示: /** * @param scrollFraction In range `[0..1]`. */ 您可以使用HTML转义: /** *
/**
* @param scrollFraction In range [0..1].
*/
但Dokka/Kdoc将方括号内的内容解释为引用。当您在IDE中检查函数的文档或生成文档时,这会导致糟糕的注释呈现。如何在Dokka/Kdoc中转义方括号/其他符号?您应该能够使用`symbol,如下所示:
/**
* @param scrollFraction In range `[0..1]`.
*/
您可以使用HTML转义:
/**
* @param scrollFraction In range [0..1].
*/
应在Dokka中输出为范围[0..1]。
,因为和#91代码>转义为[
和];
转义为]
注意,这在内联代码段内不起作用(在严重重音之间-像这样)
在这种情况下,通常使用方括号([和])。这也会以代码字体(而不是常规字体)排版背景符号中的内容。因此,这个答案解决了这个问题,同时介绍了它自己的问题。