「dokka」とは？
Kotlin用のドキュメント自動生成ツールです。
Kotlin公式が提供しています。
環境
- OS：macOS Mojave 10.14
- Kotlin：1.3.21
- Gradle：5.2.1
- dokka：0.9.17
セットアップ
インストール
appフォルダ配下の「build.gradle」にdokkaのプラグインと設定を追加します。
/app/build.gradle
+ apply plugin: 'org.jetbrains.dokka-android'
+
+ dokka {
+ outputFormat = 'html'
+ outputDirectory = "$buildDir/javadoc"
+ }
ルート直下の「build.gradle」にdokkaのバージョンとクラスパスを追加します。
/build.gradle
buildscript {
ext {
+ dokka_version = '0.9.17'
}
dependencies {
+ classpath "org.jetbrains.dokka:dokka-android-gradle-plugin:$dokka_version"
}
}
実装
ドキュメント化したいメソッドやプロパティにドキュメンテーションコメント(KDoc)を付けます。
例
MainActivity.kt
package com.example
import android.os.Bundle
import android.support.v7.app.AppCompatActivity
/**
* メインアクティビティ
*/
class MainActivity : AppCompatActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
}
/**
* 2つの数字を足す
*
* @param x 数字1
* @param y 数字2
* @return 数字1 + 数字2
*/
fun add(x: Int, y: Int): Int {
return x + y
}
}
ドキュメントの生成・閲覧
Android Studioのターミナルで ./gradlew dokka を実行すると、 outputDirectory で指定したフォルダ(/app/build/javadoc/)内にドキュメントが生成されます。
「…javadoc/app/index.html」をWebブラウザで開くとドキュメントを閲覧できます。
非常にシンプルなデザインです。
おわりに
ここでは簡単にしか紹介していません。
dokkaの使い方についてもっと詳細に知りたい場合は参考リンクなどをご参照ください。
KDocについては以下のページが参考になります。
https://kotlinlang.org/docs/reference/kotlin-doc.html
https://qiita.com/opengl-8080/items/fe43adef48e6162e6166