Loading [MathJax]/jax/output/CommonHTML/config.js
前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >专栏 >Dokka 设置包描述,让你的 Kotlin 库文档更详实

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

作者头像
技术小黑屋
发布于 2021-04-01 23:40:15
发布于 2021-04-01 23:40:15
1.2K0
举报
文章被收录于专栏:技术小黑屋技术小黑屋

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")

示例内容

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
暂无评论
推荐阅读
编辑精选文章
换一批
Kotlin 文档注释的生成-Dokka 1.6.0
我们如果是进行SDK或者API的提供者。那么当编写过多的代码之后。需要提供规范的API帮助文档。
zinyan.com
2023/07/13
6800
Kotlin 文档注释的生成-Dokka 1.6.0
Android代码静态检查(lint、Checkstyle、ktlint、Detekt)
在Android项目开发过程中,开发团队往往要花费大量的时间和精力发现并修改代码缺陷。
静默加载
2022/12/27
2K0
Android代码静态检查(lint、Checkstyle、ktlint、Detekt)
用kotlin来开发一个cli工具 | 没用的技能+1
而在程序开发过程中,每个工程或者说公司也都需要一个脚手架工具。通过脚手架命令行的形式简化开发流程,避免发生一些人为的相对低级的问题,所以这个也就是为什么叫做脚手架的原因吧。
逮虾户
2022/12/10
1.3K0
用kotlin来开发一个cli工具 | 没用的技能+1
教你一步步发布一个开源库到 JCenter
这方面的博客网上已经特别多了,所以本篇并不打算仅仅只是记录流程步骤而已,而是尽可能讲清楚,为什么需要有这个步骤,让大伙知其然的同时还知其所以然,那么掌握就会更深刻一点,所以本篇篇幅会很长。另外,本篇是参考、引用、借鉴了以下文章中的内容:
请叫我大苏
2018/05/07
2K2
教你一步步发布一个开源库到 JCenter
落地包体积监控,用Kotlin写一个APK差异分析CLI
当谈到包体积优化时,网上不乏优秀的方案与文章,如 混淆、资源、ReDex、R8、SO 优化等等。
Petterp
2023/05/27
5670
落地包体积监控,用Kotlin写一个APK差异分析CLI
代码质量堪忧?用 detekt 呀,拿捏得死死的~
930改革之后,我们公司内部的技术基建的发展有了显著的成效,对于代码质量的追求也成为工程师们日常生活中最重要的几件事之一。对于我们 Kotlin 开发者而言,代码的静态扫描其实意义非凡,除了让公司项目代码风格保持统一以外,也能够纠正我们日常开发当中的不当写法,对于提升我们的编码意识有很好的效果。所以,我特别邀请我们组内的小伙伴撰写了这篇关于 detekt 的上手指南,希望对提升大家的代码质量有帮助。
bennyhuo
2021/04/09
3.8K0
代码质量堪忧?用 detekt 呀,拿捏得死死的~
Flutter 即学即用——03 在旧有项目引入 Flutter
其实如果打算在实际项目中引入 Flutter,完全将旧有项目改造成纯 Flutter 项目的可能性比较小,更多的是在旧有项目引入 Flutter。
AndroidTraveler
2019/02/25
1.5K0
来开源吧!发布开源组件到 MavenCentral 仓库超详细攻略
小彭今天和群友讨论了一下学习方法的问题,觉得还挺感同身受的。有时候我们遇到不懂的地方,潜意识会产生厌恶和恐惧,大脑会驱使我们去学习和查看这个不懂的地方,结果有可能是陷入到另一个不懂的循环里,忘记了最初的目的。关于系统化学习和碎片化学习,你的想法是怎样的呢?评论区里告诉我吧。
用户9995743
2022/09/26
2.1K0
来开源吧!发布开源组件到 MavenCentral 仓库超详细攻略
多个语言项目发布JCenter仓库的小结
我在 JCenter 上发布过 Java、Android、Kotlin 的项目已经有数十个了。踩坑无数,所以写下这篇文章,作为记录和总结。
fengzhizi715
2018/08/24
7470
多个语言项目发布JCenter仓库的小结
Kotlin + buildSrc:更好的管理Gadle依赖!
为了充分利用Android Plugin for Gradle 3.0+的优点,将Android项目拆分成多个module的做法越来越常见。然而,随着module数量的增多,我们很快就会遇到依赖管理的混乱问题。
用户9239674
2022/01/10
2.7K0
Kotlin初体验
注意的是要在 module 的build文件下添加 要不会报Error:(6, 8) Unresolved reference: kotlinx 这个错误
tea9
2022/07/16
2830
Kotlin初体验
《Kotin 极简教程》第16章 使用 Kotlin Native第16章 使用 Kotlin Native《Kotlin极简教程》正式上架:
不得不说 JetBrains 是一家务实的公司,各种IDE让人赞不绝口,用起来也是相当溜。同样的,诞生自 JetBrains 的 Kotlin 也是一门务实的编程语言,Kotlin以工程实用性为导向,充分借鉴了Java, Scala, Groovy, C#, Gosu, JavaScript, Swift等等语言的精华,让我们写起代码来可谓是相当优雅却又不失工程质量与效率。Kotlin Native能把 Kotlin代码直接编译成机器码,也就是站在了跟 C/C++、Go和Rust的同一个层次,于是这个领域又添一位竞争对手。
一个会写诗的程序员
2018/08/17
1.3K0
《Kotin 极简教程》第16章 使用 Kotlin Native第16章 使用 Kotlin Native《Kotlin极简教程》正式上架:
Android NDK开发:打包so库及jar包供他人使用
这篇文章会讲第一种方式来打包so库,这种方式是基于jni层的,需要我们同时提供接口的jar包来配合使用,适用于对方从java层调用我们的库。因为jni中的函数名是有特殊要求的,它会指定jni的java接口的路径,如果不提供jar包,那么使用者就要按照我们在jni头文件中声明的函数名来建立java文件,这将是非常痛苦的。
全栈程序员站长
2022/06/28
2.9K0
Android NDK开发:打包so库及jar包供他人使用
Flutter Android 工程结构及应用层编译源码深入分析
本文部分配图及源码最近基于 Flutter 2.2.3 版本进行了修正更新发布。目的是为了弄清 Flutter 在安卓端应用层的整个编译来龙去脉,以便编译过程中出任何问题都能做到心里有数,另一个目的是为了能够在应用层定制 Flutter 编译。全文比较长,图文并茂,由工程结构深入到源码解析。
工匠若水
2021/08/18
3.4K0
Gradle Kotlin DSL指南
Gradle的Kotlin DSL提供了一种替代传统Groovy DSL的语法,它在受支持的ide中增强了编辑体验,具有更好的内容辅助、重构、文档等功能。本章详细介绍了主要的Kotlin DSL结构,以及如何使用它与Gradle API进行交互。
从大数据到人工智能
2022/01/19
10.7K0
Gradle Kotlin DSL指南
Kotlin Native实战开发
Kotlin Native是一种将Kotlin源码编译成不需要任何VM支持的目标平台二进制数据的技术,编译后的二进制数据可以直接运行在目标平台上,它主要包含一个基于LLVM的后端编译器的和一个Kotlin本地运行时库。设计Kotlin Native的目的是为了支持在非JVM环境下进行编程,如在嵌入式平台和iOS环境下,如此一来,Kotlin就可以运行在非JVM平台环境下。
xiangzhihong
2022/11/30
1.4K0
解决thrifty-compiler.jar运行报错不能编译IDL生成java class代码问题
版权声明:本文为博主原创文章,转载请注明源地址。 https://blog.csdn.net/10km/article/details/85761248
10km
2019/05/25
1.4K0
​前端开发者的 Kotlin 之旅:理解 Gradle关键文件与目录
在深入了解具体文件之前,让我们先建立前端构建工具与 Gradle 之间的概念映射:
骑猪耍太极
2025/04/19
930
​前端开发者的 Kotlin 之旅:理解 Gradle关键文件与目录
《Springboot极简教程》 Springboot plus Kotlin :Hello,WorldKotlin, Console: Hello,WorldSpringBoot Kotlin JP
https://github.com/MiniSpringBootTutorial/mini_springboot/blob/master/src/main/kotlin/jason/chen/mini_springboot/console/HelloWorld.kt
一个会写诗的程序员
2018/08/20
1.2K0
《Springboot极简教程》 Springboot plus Kotlin :Hello,WorldKotlin, Console: Hello,WorldSpringBoot Kotlin JP
开源|携程机票 App KMM 跨端 KV 存储库 MMKV-Kotlin
作者简介 禹昂,携程移动端资深工程师,专注于 Kotlin 移动端跨平台领域,Kotlin 中文社区核心成员,图书《Kotlin 编程实践》译者。 一、背景 携程机票移动端研发团队自 2021 年始就一直在移动端实践 Kotlin Multiplatform 技术(请见参考链接 1)。由于目前 Kotlin Multiplatform 生态尚处于起步阶段,大部分 Kotlin 开源库都是 JVM only 的,因此在我们团队的日常开发过程中迫切需要一些能够支持 KMM(Kotlin Multiplatf
携程技术
2022/06/17
1.9K0
开源|携程机票 App KMM 跨端 KV 存储库 MMKV-Kotlin
推荐阅读
相关推荐
Kotlin 文档注释的生成-Dokka 1.6.0
更多 >
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档