Zenn
📱

[Android]Kdocの作成方法

2022/01/10に公開
Android
Kotlin
Android Studio
javadoc
KDoc
tech

概要

JavaDocやKdocの記述方法はネットでよく出てくるが、Kdocの導入部分についてはあまり情報が無かったので備忘録として残す。

Kdocとは

Kotlin のソースコード上に書いたドキュメンテーションコメントから生成された API ドキュメント

導入

  1. プロジェクトレベルのbuild.gradle dependenciesの中に以下追加
classpath"org.jetbrains.dokka:dokka-gradle-plugin:1.4.30"
  1. アプリレベルのbuild.gradle pluginsの中に以下追加
id 'org.jetbrains.dokka'
  1. 説明を記述する
    /***/の中に書くとドキュメンテーションコメントとなる
/**
 * クラスやメソッドの説明
 * パラメータ名
 * @return 返り値
 */
  1. ドキュメントを生成する
    ターミナルで下記コマンドを実行。
    gradlew.bat dokkaHtml
    BUILD SUCCESSFULが表示されればOK
    アプリレベルのbuildファイルにindex.htmlが作成される。

追記

  1. 上記でKdocが生成されるが、初期プロジェクト作成時に自動に生成されるクラス、メソッドに関しても出力されてしまう。
    これを解消にするにはアプリレベルのbuild.gradleのandroidの中に下記を追加。
dokkaHtml.configure {
    dokkaSourceSets {
        named（ "main"）{
            skipDeprecated.set（true）
            } 
       } 
}

再度下記コマンドを実行すれば必要なものだけ出力されるようになる。
gradlew.bat dokkaHtml

  1. ちなみにJavadocも出力できる。
    gradlew.bat dokkaJavadoc

Discussion