如何在KDoc(Kotlin)中正确使用@link和@code来记录代码?
大家好!我最近开始学习Kotlin,并尝试使用KDoc记录我的函数。我了解到可以使用`@link`和`@code`标签,但始终无法让它们正常工作。
以下是我的函数示例:
```kotlin
/**
* 计算两个数字的和。
* 使用 @link Calculator 进行计算。
* @param a 第一个数字,类型为 @code Int。
* @param b 第二个数字,类型为 @code Int。
* @return 结果,类型为 @code Int。
*/
fun add(a: Int, b: Int): Int {
return a + b
}
```
问题在于,在生成的文档中(例如在Dokka中),我看到的是纯文本`@link Calculator`和`@code Int`,而不是格式化的链接或等宽字体文本。我期望`@link`能创建一个指向`Calculator`类的可点击链接,而`@code`能将`Int`高亮显示为代码。
我尝试了不同的写法:写了`{@link Calculator}`、`[Calculator]`,但都不起作用。在KDoc的官方文档中,说明支持`@link`和`@code`标签。