Android studio中利用Dokka插件生成注释文档
一,开发介绍
由于从android studio 3.0开始支持kotlin语言,或者旧版本中通过kotlin插件来支持kotlin语言的开发,导致无法继续使用软件自带的javadoc生成工具为工程生成API注释文档。根据官网介绍,kotlin语言可通过Dokka插件来生成API注释文档,但手动配置脚本然后通过命令行来生成文档的流程比较繁琐,且容易出错,因此开发了此款工具“GenerateDokka.exe”,该工具具有自动完成上述所有流程的功能,且软件界面、使用方式均与javadoc生成工具类似,该工具使用的唯一条件就是在android studio软件中配置好Dokka插件。
GenerateDokka工具下载地址:http://download.youkuaiyun.com/detail/u013662621/9854176
Dokka插件下载地址:http://download.youkuaiyun.com/detail/u013662621/9854188
二,如何配置Dokka插件
具体步骤如下:
1),准备资源包dokka-gradle-plugin.jar和.pom、dokka-fa