Dokka 소개

Dokka 소개 (Introduction)

Kotlin 프로젝트의 API 문서를 만들 때, 가장 먼저 떠올릴 만한 도구가 바로 Dokka예요. 이번에는 Dokka가 어떤 엔진이고, 어떤 방식으로 문서를 만들어 주는지 하나씩 짚어볼게요.

출처: Introduction

본문

Dokka는 Kotlin을 위한 API 문서 생성 엔진이에요.

Kotlin 자체가 그렇듯 Dokka도 혼합 언어(mixed-language) 프로젝트를 지원해요. Kotlin의 KDoc 주석과 Java의 Javadoc 주석을 모두 이해해요.

Dokka는 여러 형식으로 문서를 생성할 수 있어요. 자체적으로 개발된 현대적인 HTML 형식, Java의 Javadoc HTML, 그리고 GFM과 Jekyll 방식의 Markdown도 지원해요.

API 레퍼런스 문서에 Dokka를 쓰고 있는 라이브러리들을 몇 가지 소개할게요:

• kotlinx.coroutines
• Bitmovin
• Hexagon
• Ktor
• OkHttp

Dokka는 Gradle, Maven, 또는 커맨드 라인에서 실행할 수 있어요. 게다가 플러그인 구조로 확장이 아주 자유로워요.

Dokka를 처음 써보고 싶다면 Get started with Dokka 문서를 보면서 첫걸음을 떼보세요.

Community

Dokka는 Kotlin Community Slack에 전용 #dokka 채널이 있어요. 여기서 Dokka나 관련 플러그인, 플러그인 개발 방법에 대해 이야기하고, 메인테이너와도 연락할 수 있어요.

더 알아보기

• Dokka로 Javadoc 형식의 문서를 만드는 방법은 Dokka Javadoc에서 확인해요.
• Maven 프로젝트에서 Dokka를 쓰는 법은 Dokka Maven에서 배울 수 있어요.
• 플러그인으로 Dokka를 확장하는 법은 Dokka plugins를 참고해요.