Где разместить документацию для файла 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) комментарии для такой документации и поместить ее в место, где ее будет удобно найти для читателей-людей (скорее всего после блока импорта), потому что машины не используют эту информацию.

Answer 2

Если вы используете комментарий об авторских правах, так что вы можете поместить его перед объявлением package

Если вы используете комментарии к документу для информации о вашем файле, вы можете поставить его после imports