Dokka一款Kotlin项目生成文档工具


highlight: a11y-dark

小知识,大挑战!本文正在参与“ 程序员必备小知识 ”创作活动

本文同时参与 「掘力星计划」 ,赢取创作大礼包,挑战创作激励金

一. 概述

二. kotin项目文档生成工具Dokka

Android studio自带工具可以生成文档吗?

Android studio 自带的Generate JavaDoc可以生成纯Java项目和kotkin和Java混合项目中的Java代码部分

无法生成kotlin代码输入的项目文档

kotlin项目如何生成文档
  • 这里可以使用GitHub上的一个文档生成工具Dokka
  • Dokka不仅可以生成纯kotlin项目
  • 还可以生成kotlin和Java混合开发的项目,并生成文档
  • Dokka支持多种格式输出(html,javadoc,markdown..)

三. 项目中Dokka的配置

1.在projectbuild.gradle中添加仓库和依赖

  1. buildscript {
  2. repositories {
  3. maven { url http://maven.aliyun.com/nexus/content/groups/public/ }
  4. // 或者jcenter()
  5. ......
  6. }
  7. dependencies {
  8. ......
  9. classpath org.jetbrains.dokka:dokka-gradle-plugin:0.10.1
  10. }
  11. }

2.在app的build.gradle中添加插件以及配置dokka参数

  1. apply plugin: org.jetbrains.dokka
  2. android {
  3. ......
  4. dokka {
  5. outputFormat = javadoc
  6. outputDirectory = "$buildDir/dokka"
  7. configuration {
  8. // Do not output deprecated members
  9. skipDeprecated = true
  10. // Emit warnings about not documented members.
  11. reportUndocumented = true
  12. // Do not create index pages for empty packages
  13. skipEmptyPackages = true
  14. noJdkLink = true
  15. noStdlibLink = true
  16. noAndroidSdkLink = true
  17. }
  18. }
  19. }
  20. dependencies {
  21. ......
  22. }

按上图配置完成后,sync同步项目即可完成配置

四. 如何使用Dokka生成文档

4.1 通过右侧Gradle窗口中Document中的dokka

  • 打开右侧的Gradle窗口,然后通过 项目名 --> app --> Tasks --> documentation --> dokka找到该任务,双击运行任务
    ```mermaid
    graph LR
    1{{Gradle窗口}}—>A[项目名] —> B[app] —> C[Tasks] —>D[documentation ] —>E{dokka}

`` 4.2 在terminal窗口中输入./gradlew dokka`运行任务

  • 打开底部Terminal窗口,在窗口中输入gradlew dokka执行任务

五. 查看Dokka生成文档

依次打开:项目—>app—>build—>dokka(build.gradle中配置生成文件夹)—>右键使用浏览器打开index.html


文章标签:

原文连接:https://juejin.cn/post/7018004705804550180

相关推荐

[原创]移动相机九点标定工具原理及实现(包涵部分源码)

34个图片压缩工具集合,包含在线压缩和CLI工具

[原创]一种自动化九点标定工具原理(包涵部分源码)

接口文档管理工具,选yapi 还是 Apifox? 这里列出了两款软件的深度分析,看完再下载不迟。

使用ComposeDesktop开发一款桌面端多功能APK工具

这个好用的办公网优化工具,官宣免费了

Sunmao——一个开发低代码工具的开源框架

前端必备 | 3分钟白嫖我常用的免费效率工具!

好用的办公网优化工具OneDNS

KusionStack 开源|Kusion 模型库和工具链的探索实践

从“AI玩具”到“创作工具”的云原生改造之路

LabelImg(目标检测标注工具)的安装与使用教程

效率低?响应慢?报表工具痛点及其解决方案

接口文档进化图鉴,有些古早接口文档工具,你可能都没用过

用 JavaScript 复原何同学B站头图、对前端构建工具的一些理解、弹幕的常规设计与实现 丨酱酱的下午茶第31期

关于目前流行的 Redis 可视化管理工具的详细评测

【云原生 • DevOps】一文掌握持续集成工具 Jenkins

【一起学Rust】Rust包管理工具Cargo初步了解

窥探性能的接口测试工具,性能优化的开端

照妖镜:一个工具的自我超越