Android開発におけるドキュメント作成"Dokka / KDoc"の導入手順

Dokkaとは

"KDoc"形式で記載したコメントを、Javadocと同様な形でドキュメントを作成できる。
JavaとKotlinが混在したプロジェクトのドキュメントも生成可能

導入

project/build.gradle

buildscript { 
  ext {
    dokka_version = "1.6.10"
  }
  dependencies {
    classpath "org.jetbrains.dokka:dokka-gradle-plugin:${dokka_version}"
  }

app/build.gradle

apply plugin: "org.jetbrains.dokka"

android {}
dependencies {}

// dokkaHtml 用の設定
dokkaHtml.configure {
    outputDirectory.set(new File("${buildDir}/dokkaHtml"))
    dokkaSourceSets {
        configureEach {
            // Moduleやパッケージに対するドキュメントを作成する際に指定する
            includes.from("ModuleDoc.md", "PackageDoc.md")
        }
    }
}

モジュールコメント

ここで全体的なパッケージ構成を書いておくと理解が進みそう

app/ModuleDoc.md

# Module app

## パッケージ構成について

| Package | Contents |
| ---- | ---- |
| view | view |
| viewmodel | ViewModel |
| domain | logic / service |
| model | Data model |
| repository | Repository |
| infra.api | Remote Resource |
| infra.db | Local DB |
| infra.local | Local Resource |

パッケージコメント

パッケージに対するコメント

app/PackageDoc.md

#Package jp.co.foxsal.githubreader.view.repolist
リポジトリ一覧

#Package jp.co.foxsal.githubreader.view.repodetail
リポジトリ詳細

クラス/メソッド等のコメント

KDoc形式で各所に記載する

ドキュメント生成

./gradlew dokkaHtml
または
./gradlew dokkaJavadoc

成果物イメージ

dokkaHtml	dokkaJavadoc

参考リンク

KDoc

dokkaHtmlのオプション設定