项目接口文档输出插件 javaDoc dokka doxygen的使用与配置 doxygen输出界面的美化方法

JavaDoc

• 因合作开发的普遍流行，一个项目的结构文档在项目中起到了一个至关重要的作用，下面介绍三款可以自动生成javaDoc文件的插件，其中两款适用于Android Studio

Android Studio自带javaDoc工具

流程

• 点击菜单栏——Tools——Generate JavaDoc

• 配置javaDoc的参数

  command line and arguments输入内容：-encoding utf-8 -charset utf-8

  不添加这一行可能会生成文档失败

• 点击Generate生成文档，文档生成完毕后自动浏览器显示

优缺点

优点

• 简介方便，不需要自主配置就能一键生成

缺点

• 文档界面比较过时，不够美化
• 只能解析java文件，不能够适配kotlin文件

dokka

官网

• [dokka github](Kotlin/dokka: API documentation engine for Kotlin (github.com))
• [kotlinlang.org](Introduction | Kotlin Documentation (kotlinlang.org))

简介

• 

• 以下是使用dokka生成的各类文档界面

  

配置流程

gradle

1. 在项目的gradle中加入引入这行参数 id(“org.jetbrains.dokka”) version “1.9.10” apply false

   import org.gradle.kotlin.dsl.apply
   import org.