kotlin - 将 Kotlin 文件的文档放在哪里(不是包、不是模块、不是类)

Question

我应该在哪里添加有关 Kotlin 源文件的注释？

类和其他对象具有 KDoc:

/**
 * Summary
 *
 * Rest of documentation goes here.
 */
class A {
    ...
}

但是我应该把这样的东西放在哪里呢？

// This file contains constants shared between frontend and backend.
// Make sure not to use any JVM- or JS-specific import.
// ...

在package声明之前？之后呢？我应该使用 KDoc 注释/ block 注释/行注释吗？

有什么既定的约定吗？

Answer 1

文件不是 API 的一部分，因此没有地方可以放置文件的文档以便 Dokka 选取它。您应该对此类文档使用常规(而不是 KDoc)注释，并将其放在人类读者可以轻松找到的位置(很可能在导入 block 之后)，因为机器对此信息没有用处。