Kotlin KDoc:文档?

Posted

技术标签:

【中文标题】Kotlin KDoc:文档?【英文标题】:Kotlin KDoc: Documentation? 【发布时间】:2015-04-16 03:53:02 【问题描述】:

我看到 here、here 和 there 引用了 KDoc,它是 Kotlin 的 JavaDoc 实用程序。

但是,我找不到任何关于如何使用它的文档,更不用说如何自定义它或将它集成到 Maven 或 Gradle 中了。

我知道Kotlin API doc 是使用 KDoc 生成的,因为页面源具有以下 html 注释:<!-- Generated by kdoc on Sun Jul 06 20:27:33 UTC 2014 -->

那么,有没有关于如何使用 KDoc 的文档可供参考?

【问题讨论】:

【参考方案1】:

看起来 Kdoc 被放在了次要位置以支持 Dokka。 https://github.com/Kotlin/dokka

来源:https://devnet.jetbrains.com/thread/458339;jsessionid=B2038D70DCC9004181B20D6D4EA2B2A3

【讨论】:

这个答案不准确。 KDoc 仍然存在;它只是改变了。 Dokka 只是从 KDoc 生成 HTML 文档的工具。 kotlinlang.org/docs/reference/kotlin-doc.html

以上是关于Kotlin KDoc:文档?的主要内容,如果未能解决你的问题,请参考以下文章

使用Dokka为Kotlin代码生成KDoc

如何继承 KDoc 文档?

KDoc:插入代码片段

生成 Kotlin 方法/类注释

Kotlin 官网 文档 教程 视频 资源

对比Java学Kotlin官方文档目录