您是否曾经为您的图书馆/项目生成Kotlin Docs（KDOC）？我有。有一个称为Dokka的工具，您可以找到here。设置并不难。
我亲自使用dokka作为我为SharedPreferences写的small API。无论如何，这些步骤非常基本。不过，您必须小心的一件事是很好地了解syntax of the Kdocs（通常，如果您知道如何生成Javadoc，Kotlin Docs没有太大的区别）。
让我们以一个简单的例子：
/** Reads a String from SharedPreferences
* @param [key] the key provided to find the stored value
* @return [String] the data of type String if found if not returns an empty String
* @throws [java.lang.ClassCastException] if the key is found but is not a String
*/
@Throws(java.lang.ClassCastException::class)
fun readString(key: String, defaultStringValue: String = ""): String =
sharedPreferences.getString(key, defaultStringValue)
?: throw java.lang.ClassCastException("The key exists, but its' value not of type String")
所有评论的线条将稍后生成我们所谓的Kotlin Docs/kdocs（或者您可以对人们大喊：“阅读血腥的文档”ðÖ）。谨慎地描述该功能的功能并检查其所有组件，参数，返回值，异常是为您的项目生成清晰文档的关键。
所以，让我们先设置dokka。
转到build.gradle（项目级）并添加此行：
classpath "org.jetbrains.dokka:dokka-gradle-plugin:0.9.18" //or later version
比在build.gradle（级别模块）中应用插件：
apply plugin: 'org.jetbrains.dokka'
...
android {
...
dokka {
outputFormat = 'html'
outputDirectory = "$buildDir/javadoc"
}
}
现在都设置了。您可能会注意到格式将是HTML。随时检查文档是否其他格式（从未使用过其他格式）。
所以，假设您已经写了一些评论，目的是生成文档。之后，只需输入：
./gradlew dokka
等待几秒钟，在那里您会看到一些成功消息，或者如果您做错了什么，CLI会通知您。
如果您已经成功生成了文档，则将在构建文件夹上找到文件。之后，这取决于您在哪里托管它们（我使用github页面）。文档的CSS非常漂亮而且很简单。但是您可以根据需要修改。
Here是您可以看到有关Kotlin文档的示例。
Stavro Xhardha