如何转义 Kotlin 文档中的符号 Dokka/Kdoc?
How to escape symbols in Kotlin documentation Dokka/Kdoc?
我想添加这样的评论
/**
* @param scrollFraction In range [0..1].
*/
但是 Dokka/Kdoc 将方括号内的内容解释为参考。当您在 IDE 中检查函数的文档或生成文档时,这会导致注释呈现错误。如何转义 Dokka/Kdoc 中的正方形 brackets/other 符号?
你应该可以使用 ` 符号来完成,就像这样:
/**
* @param scrollFraction In range `[0..1]`.
*/
可以使用HTML转义:
/**
* @param scrollFraction In range [0..1].
*/
应该在 Dokka 中输出为 range [0..1].
,因为 [
转义为 [
而 ]
转义为 ]
.
请注意,这在一段内联代码中不起作用(在重音符之间 - like this
)。
对于这种情况,通常使用方括号([ 和 ]),如 .
中所建议的
我想添加这样的评论
/**
* @param scrollFraction In range [0..1].
*/
但是 Dokka/Kdoc 将方括号内的内容解释为参考。当您在 IDE 中检查函数的文档或生成文档时,这会导致注释呈现错误。如何转义 Dokka/Kdoc 中的正方形 brackets/other 符号?
你应该可以使用 ` 符号来完成,就像这样:
/**
* @param scrollFraction In range `[0..1]`.
*/
可以使用HTML转义:
/**
* @param scrollFraction In range [0..1].
*/
应该在 Dokka 中输出为 range [0..1].
,因为 [
转义为 [
而 ]
转义为 ]
.
请注意,这在一段内联代码中不起作用(在重音符之间 - like this
)。
对于这种情况,通常使用方括号([ 和 ]),如