专栏首页技术小黑屋Dokka 设置包描述,让你的 Kotlin 库文档更详实

Dokka 设置包描述,让你的 Kotlin 库文档更详实

Dokka 是啥

  • Dokka 是 Kotlin 生成类似 Javadoc 文档的工具,可以为 Kotlin 的库依据代码和注释等信息生成技术文档。
  • Dokka 的 github 地址为 https://github.com/Kotlin/dokka 不了解的同学可以先了解一下。

痛点

  • 像类,方法等都可以在代码文件中进行添加注释来增加必要的描述
  • 而 包 没有对应的代码文件载体,无法直接添加。

好在,搜索了外文文档,找到了对应的方法,特此记录一下,希望可以帮到其他人。

创建对应的 mardkown 文件

  • 在期望的模块 (Module) 内部
  • 不一定与build.grale同级,可以是新目录下,这里以同级为例
  • 命名随意,没有限制
  • 文件内容为 markdown 格式

比如我们创建一个文件为packages.md,内容如下

1 2 3 4 5

# Package com.secoo.coobox.library.impl 这里填写关于 `com.secoo.coobox.library.impl`的描述信息 ## 这里也是 `com.secoo.coobox.library.impl` 的描述信息哈

如何引入描述信息

在对应的模块下的build.gradle中增加includes.from("packages.md")

1 2 3 4 5 6 7 8 9 10 11 12 13 14

dokkaHtml { outputDirectory.set(new File(rootDir, "dokkadocs")) // Set module name displayed in the final output moduleName.set("library") dokkaSourceSets { configureEach { // Or source set name, for single-platform the default source sets are `main` and `test` includes.from("packages.md") // 此处省略其他配置 } }

效果

使用./gradlew dokkaHtml 生成文档文件

包索引页的效果

包详细页的效果

如何支持多个

  • 可以支持多个,这样避免了超级文件的产生
  • 增加新的markdown文件,比如 packages_1.md
  • 在 gradle 文件中这样配置 includes.from("packages.md", "packages_1.md")

示例内容

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • [更正视频] 如何为 Gradle 的 KTS 脚本添加扩展?

    (抱歉各位,之前发布的内容当中视频嵌入成“迁移 KTS”那一节的视频了,这次重新发布,更正视频内容,感谢大家的支持!)

    bennyhuo
  • 如何为 Gradle 的 KTS 脚本添加扩展?

    现在我们的 Gradle 脚本都迁移到 KTS 了。接下来我们要考虑的问题是,能不能添加一些好用的扩展,方面后续脚本的编写?

    bennyhuo
  • 你还在用 MyBatis 吗,Ktorm 了解一下?

    Google 宣布 Kotlin 成为 Android 的官方语言,Kotlin 可以说是突然火了一波。其实不仅仅是 Android,在服务端开发的领域,Kot...

    bennyhuo
  • Gradle 构建脚本

    Gradle提供了一种领域特定语言,目前同时支持 Groovy 和 Kotlin 。

    佛系编码
  • 开发工具总结(7)之多年珍藏的Android开发必备网站和工具

    版权声明:本文为博主原创文章,未经博主允许不得转载。https://www.jianshu.com/p/781c1b56bc5b

    AWeiLoveAndroid
  • 使用 Kotlin 构建的常见问题解答 | Kotlin 迁移指南 (下篇)

    今年五月份的 Google I/O 上,我们正式向全球宣布 Kotlin-first 的这一重要理念,Kotlin 将成为 Android 开发者的首选语言,十...

    Android 开发者
  • 一切皆是文件:UNIX,Linux 操作系統的設計哲學

    说到进程,恐怕面试中最常见的问题就是线程和进程的关系了,那么先说一下答案:在 Linux 系统中,进程和线程几乎没有区别。

    一个会写诗的程序员
  • 微信团队分享:Kotlin渐被认可,Android版微信的技术尝鲜之旅

    本文由微信开发团队工程是由“oneliang”原创发表于WeMobileDev公众号,内容稍有改动。

    JackJiang
  • Kotlin 1.4 现已发布,专注于质量和性能

    Kotlin 1.4.0 今日发布!在过去的几年里,我们一直在努力使 Kotlin 成为一种有趣、令人愉快且高效的编程语言。为了借助此版本的 Kotlin 继续...

    bennyhuo

扫码关注云+社区

领取腾讯云代金券