如何在Kotlin文档中引用测试根目录下的Spek Spec？

嘿，我之前也碰到过一模一样的困扰——测试根目录下的Spek Spec默认不在主源码的文档索引范围内，IntelliJ找不到完全是正常情况。给你几个实用的解决办法：

1. 直接用IntelliJ专属文件链接 #

这是IDE内最直接的解决方案，用相对项目根目录的文件链接语法，让IntelliJ直接定位到测试文件：

[你的Spec类名](file://$PROJECT_DIR$/src/test/kotlin/你的包路径/YourSpec.kt)

举个实际例子：如果你的Spec在src/test/kotlin/com/myapp/LoginSpec.kt，文档在src/main/docs/API.md，那链接就这么写：

[LoginSpec](file://$PROJECT_DIR$/src/test/kotlin/com/myapp/LoginSpec.kt)

这个写法是IntelliJ特有的，但在IDE里点击就能直接跳转到对应的Spec文件，体验特别顺畅。

2. 调整文档生成工具的扫描范围（以Dokka为例） #

如果你的文档是用Kotlin官方的Dokka生成的，默认它只扫描主源码目录，你可以把测试源码也加入扫描范围，这样就能直接通过类全限定名引用Spec了。

在Gradle的build.gradle.kts里添加配置：

dokkaHtml {
    // 包含你的文档文件
    includes.from("src/main/docs/你的文档.md")
    sourceSets {
        // 保留主源码扫描
        named("main") {}
        // 加入测试源码扫描，允许引用测试类
        named("test") {
            includeNonPublic = true
        }
    }
}

配置完成后，生成的文档里就可以直接这样引用：

[LoginSpec](com.myapp.LoginSpec)

Dokka会自动为这个类生成跳转链接。

3. 在KDoc注释中用@see标签引用 #

如果是在Kotlin代码的文档注释（KDoc）里想引用Spec，你可以用@see标签加上Spec的全限定名：

/**
 * 处理用户登录的核心逻辑
 * 测试用例参考 @see com.myapp.LoginSpec
 */
fun handleLogin(username: String, password: String): Boolean {
    // 逻辑实现
}

前提是你的测试目录已经被IntelliJ标记为Test Sources Root（默认新建项目时会自动标记），这样IDE就能识别到测试类并提供跳转。

内容的提问来源于stack exchange，提问作者nikolausk