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 注释/块注释/行注释吗？

有没有既定的约定？

score 2 · Accepted Answer

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

score 0 · Accepted Answer

如果您使用版权注释，则可以将其放在package声明之前

如果您正在使用有关文件信息的文档注释，则可以将其放在imports

2 回答 2