我想添加这样的评论
/** * @param scrollFraction In range [0..1]. */
但是Dokka/Kdoc将方括号内的内容解释为引用,这会导致在IDE中检查函数文档或生成文档时,注解的显示效果不佳。如何转义Dokka/Kdoc中的方括号/其他符号?
zhte4eai1#
你应该可以用'符号来做,就像这样:
/** * @param scrollFraction In range `[0..1]`. */
但是,使用'symbol会将中间的所有内容显示为代码块。要只使用方括号而不使用引用,请使用HTML符号,如@yuvgin答案中的[和]。
enxuqcxy2#
您可以使用HTML转义:
/** * @param scrollFraction In range [0..1]. */
在Dokka中应输出为range [0..1].,因为[转义为[,]转义为]。请注意,这在内联代码部分(在重音符号之间-like this)内不起作用。对于这种情况,通常使用方括号([和]),如Demigod's answer中所建议的。
range [0..1].
[
[
]
]
like this
2条答案
按热度按时间zhte4eai1#
你应该可以用'符号来做,就像这样:
但是,使用'symbol会将中间的所有内容显示为代码块。
要只使用方括号而不使用引用,请使用HTML符号,如@yuvgin答案中的[和]。
enxuqcxy2#
您可以使用HTML转义:
在Dokka中应输出为
range [0..1].
,因为[
转义为[
,]
转义为]
。请注意,这在内联代码部分(在重音符号之间-
like this
)内不起作用。对于这种情况,通常使用方括号([和]),如Demigod's answer中所建议的。