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

是否有既定惯例？

Answer 1

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

Answer 2

如果您使用的是版权评论，则可以将其放在package声明之前

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

之后