首页 > 解决方案 > 如何为文件添加顶级 KDoc?

问题描述

有没有办法为 Kotlin 文件添加一段顶级 KDoc?

由于 Kotlin 在单个文件中支持多个变量、函数、类等,因此将文件作为一个整体进行记录是有意义的。但是,Documenting Kotlin Code - Kotlin Programming Language似乎对此没有任何说明。

标签: kotlinkdoc

解决方案


没有这样的功能;但是,包和模块可以像在 Java中一样记录

在 Dokka 中,添加了带有属性的附加文档文件include(例如Gradle 配置)。


推荐阅读