在哪里放置Kotlin文件的文档(不是包,不是模块,不是类)

2023年2月27日 251次阅读

我应该在哪里发表关于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.
// ...

包裹申报之前？之后呢？我应该使用KDoc评论/阻止评论/行评论吗？

有既定的惯例？

最佳答案 文件不是API的一部分,因此没有地方可以放置文件的文档,以便Dokka选择它.您应该对这些文档使用常规(而不是KDoc)注释,并将其放在一个可以为人类读者找到的地方(很可能是在导入块之后),因为这些机器对此信息没有用处.

点赞