文档章节

android studio中kotlin语言生成API文档工具GenerateDokka

S
 Surface-pro
发布于 2017/08/15 19:31
字数 784
阅读 195
收藏 0

                                                                                                       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文档,最后再点击导出目录和导出即可,如下图所示:
 


© 著作权归作者所有

S
粉丝 2
博文 5
码字总数 7751
作品 1
珠海
程序员
私信 提问
Android Studio 3.0 正式发布,支持 Kotlin 语言

除了 Android 8.1 Oreo 开发者预览版,Google 今日还正式发布了 Android Studio 3.0 ,为其 IDE 引入了一系列新功能。 Android Studio 3.0 专注于加速 Android 应用开发,包含大量更新内容,...

王练
2017/10/26
16.9K
57
Android Studio 3.0 Canary 1 发布,支持 Kotlin 语言

Android Studio 3.0 Canary 1 发布了。官方表示,这些一直在默默迭代中的功能本应是 Android Studio 2.4 Canaries 的一部分,但今天他们意识到这个版本添加了许多重要的功能,因此将版本改成...

局长
2017/05/18
14.2K
74
Kotlin:Google让我们使用Kotlin的理由

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。 https://blog.csdn.net/p106786860/article/details/75941693 在2017 Google I/O大会的主旨演...

1024工场
2017/07/23
0
0
与Java无缝兼容,Kotlin语言的优缺点及建议

从Android 7.0开始,谷歌使用的API从Oracle JDK切换到了open JDK,这对于谷歌来说是一个艰难的决定。对于开发者来说,却倍感兴奋,这意味着长期的官司问题也许就此结束,Android系统开发又可...

架构师springboot
01/10
35
1
如何在iOS和Android的应用程序中共享Kotlin代码的功能

     在本文中,我将使用Kotlin的代码共享特性创建一个iOS和Android应用程序。对于Android,我将使用Kotlin/JVM,而对于iOS,我将使用Kotlin/Native。   你将在本文中学习到以下内容:...

嘶吼RoarTalk
2018/10/23
0
0

没有更多内容

加载失败,请刷新页面

加载更多

最简单的获取相机拍照的图片

  import android.content.Intent;import android.graphics.Bitmap;import android.os.Bundle;import android.os.Environment;import android.provider.MediaStore;import andr......

MrLins
今天
6
0
说好不哭!数据可视化深度干货,前端开发下一个涨薪点在这里~

随着互联网在各行各业的影响不断深入,数据规模越来越大,各企业也越来越重视数据的价值。作为一家专业的数据智能公司,个推从消息推送服务起家,经过多年的持续耕耘,积累沉淀了海量数据,在...

个推
今天
9
0
第三方支付-返回与回调注意事项

不管是支付宝,微信,还是其它第三方支付,第四方支付,支付机构服务商只要涉及到钱的交易都要进行如下校验,全部成功了才视为成功订单 1.http请求是否成功 2.校验商户号 3.校验订单号及状态...

Shingfi
今天
5
0
简述Java内存分配和回收策略以及Minor GC 和 Major GC(Full GC)

内存分配: 1. 栈区:栈可分为Java虚拟机和本地方法栈 2. 堆区:堆被所有线程共享,在虚拟机启动时创建,是唯一的目的是存放对象实例,是gc的主要区域。通常可分为两个区块年轻代和年老代。更...

DustinChan
今天
7
0
Excel插入批注:可在批注插入文字、形状、图片

1.批注一直显示:审阅选项卡-------->勾选显示批注选项: 2.插入批注快捷键:Shift+F2 组合键 3.在批注中插入图片:鼠标右键点击批注框的小圆点【重点不可以在批注文本框内点击】----->调出批...

东方墨天
今天
7
1

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部