Kotlin 용 문서 생성 도구 "dokka"설정 및 조작 방법

「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”을 열면 문서를 볼 수 있습니다.





매우 간단한 디자인입니다.

결론

여기에서는 간단하게 밖에 소개하고 있습니다.
dokka의 사용법에 대해 더 자세히 알고 싶다면 참고 링크 등을 참조하십시오.

KDoc에 대해서는 이하의 페이지가 참고가 됩니다.
htps : //코 tぃんぁ g. 오 rg/도 cs/레후 렌세/코 tぃんど c. HTML
htps : // 코 m / 오 글 8080 / ms / 후 43 아 f48 6162 6166

참고 링크

dokka/README.md at master · Kotlin/dokka

Kotlin 버전 Javadoc을 생성 할 수있는 "dokka"의 도입 절차 - Qiita