android studio中kotlin语言生成API文档工具GenerateDokka
来源:互联网 发布:galgame游戏删除数据 编辑:程序博客网 时间:2024/06/16 21:01
Android studio中利用Dokka插件生成注释文档
一,开发介绍
由于从android studio 3.0开始支持kotlin语言,或者旧版本中通过kotlin插件来支持kotlin语言的开发,导致无法继续使用软件自带的javadoc生成工具为工程生成API注释文档。根据官网介绍,kotlin语言可通过Dokka插件来生成API注释文档,但手动配置脚本然后通过命令行来生成文档的流程比较繁琐,且容易出错,因此开发了此款工具“GenerateDokka.exe”,该工具具有自动完成上述所有流程的功能,且软件界面、使用方式均与javadoc生成工具类似,该工具使用的唯一条件就是在android studio软件中配置好Dokka插件。
GenerateDokka工具下载地址:http://download.csdn.net/detail/u013662621/9854176
Dokka插件下载地址:http://download.csdn.net/detail/u013662621/9854188
二,如何配置Dokka插件
具体步骤如下:
1),准备资源包dokka-gradle-plugin.jar和.pom、dokka-fatjar.jar和.pom,且这4个资源版本必须相同;
2),创建目录(若存在则不创建,下同)“软件根目录/ m2repository/
gradleorg/jetbrains/dokka/dokka-gradle-plugin/版本号(如:0.9.13)”,然后将对应的jar和pom文件拷入此地;
3),创建目录“软件根目录/ gradle/m2repository/org/jetbrains/dokka/
dokka-fatjar/版本号(如:0.9.13)”,然后将对应的jar和pom文件拷入此地;
4),将文件夹“根目录/gradle/m2repository”拷贝到“SDK目录/extras”下;
5),在工程根目录下的build.gradle文件中,按如下所示配置:
buildscript {
ext.dokka_version = '0.9.13'
repositories {
maven{url "仓库绝对路径"}
}
dependencies {
classpath "org.jetbrains.dokka:dokka-gradle-plugin: ${dokka_version}"
}
}
其中绝对路径为studio安装目录/gradle/m2repository的绝对路径,如下图所示:
6),在工程app目录下的build.gradle文件中,添加“apply plugig: 'org.jetbrains.dokka'”,且保证其在其他所有plugin后面,如下图:
7),最后同步整个工程,若无错误出现,则表示Dokka配置成功;
8),开始配置如何通过Dokka输出注释文档:
方法一(手动配置):
在工程app目录下的build.gradle文件末尾,添加如下所示内容:
其中:
outputFormat为输出类型,可为javadoc、html、markdown;
outputDirectory为输出路径;
reportNotDocumented为当某个位置无注释时是否输出警告;
skipDeprecated为是否跳过Deprecated;
sourceDirs为源码路径,可为目录,也可为具体文件;
最后同步工程,若成功,则点击软件下方的Terminal,输入命令“gradlew –offline dokka”便可成功输出;
方法二(通过自动化工具快速生成):
该方法详见下一节介绍。
三,GenerateDokka工具的使用
首先将该工具以第三方工具的而形式导入android studio中(可参见文档《android开发环境中导入第三方工具的方法》),打开软件界面如下:
然后选择studio的工程根目录、输出类型(支持javadoc、html、markdown),如果选择正确,下方会显示相应的源文件选项,选择需要为哪些源文件生成API文档,最后再点击导出目录和导出即可,如下图所示:
- android studio中kotlin语言生成API文档工具GenerateDokka
- Android Studio中利用JavaDoc生成项目API文档
- Android Studio中利用JavaDoc生成项目API文档
- Android Studio中使用Kotlin语言实现AIDL通信[图文]
- Android Studio 中使用Kotlin
- php API文档生成工具
- RESTFul API文档生成工具
- API文档自动生成工具
- javadoc工具文档API生成
- API文档生成工具推荐
- RESTful API文档生成工具
- API文档管理系统,文档生成工具
- kotlin语言学习文档 for Android
- Android@Kotlin 在Android studio 中配置Kotlin
- Android Studio生成JavaDoc文档
- Kotlin基础(一)android studio中配置Kotlin
- Kotlin学习一 Android Studio 中安装 Kotlin Plugin
- Kotlin基础(一)android studio中配置Kotlin
- java二叉树的前中后序,深度优先,广度优先(层序)遍历
- 白鹭EGRET使用龙骨DRAGONBONES骨骼动画
- python DEAP学习3(遗传算法) 0-1背包问题
- table表格合并跨行中相同元素的列
- 没有找到draw9patch.bat
- android studio中kotlin语言生成API文档工具GenerateDokka
- ElasticSearch基础教程
- Servlet 详解
- 【Mapreduce】从代码上解决Output directory already exists错误,避免每次调试都要手动删除输出文件夹
- JavaWeb
- 数据结构(查找)
- Linux_MongoDB 安装笔记
- 自定义dialog
- 自定义ImageView