[android]kotlin kdoc(java doc 대체)

 

 

format auto generator 

install plug in KDoc-er - Kotlin Doc Generator

 

MAC : android studio -> preferences -> plugins

WIN : fie -> setting -> plugins

 

android preferences

 

 

generator document

 

excute gralde task

gradle dokkaHtml

PATH(dokkaHtml) : ./module(app)/build/dokka

 

project gradle

plugins {
    ...
    id 'org.jetbrains.dokka' version '1.6.10'
}

 

module(app) gradle

plugins {
    ...
    id 'org.jetbrains.dokka'
}

android {
    ...
    dokkaHtml.configure {
        dokkaSourceSets {
            named("main") {
                noAndroidSdkLink.set(false)
            }
        }
    }

}

dependencies {
	...
}

 

 

 

write guide

kotlin home (https://kotlinlang.org/docs/kotlin-doc.html)

android developer ( https://developer.android.com/kotlin/style-guide?hl=ko )

구조

.kt 파일은 다음과 같은 순서로 구성됩니다.

• 저작권 및/또는 라이선스 헤더(선택사항)
• 파일 수준 주석
• Package 문
• Import 문
• 최상위 수준 선언

빈 줄을 하나만 사용하여 각 섹션을 구분합니다.

저작권/라이선스

파일에 저작권 또는 라이선스 헤더가 포함된 경우 맨 위에 여러 줄로 주석을 넣어야 합니다.

 

/*
 * Copyright 2017 Google, Inc.
 *
 * ...
 */
 

KDoc 스타일 또는 한 줄 주석을 사용하지 마세요.

 

/**
 * Copyright 2017 Google, Inc.
 *
 * ...
 */

 

// Copyright 2017 Google, Inc.
//
// ...

파일 수준 주석

use-site target '파일'을 포함하는 주석은 헤더 주석과 패키지 선언 사이에 배치됩니다.