Kdoc이란?

코드가 제대로 유지보수 되려면 문서화가 필수

여기서 Kotlin 코드를 문서화하는 데 사용되는 언어를 KDoc이라고 함

Javadoc vs Kdoc

Java의 JavaDoc과 거의 비슷함

기본적으로 KDoc과 JavaDoc 모두 /** .. */

형태의 주석으로 작성함.

하지만 JavaDoc은 HTML, KDoc은 Markdown기반이라는 차이점이 있음.

Block tags

@param: 매개변수에 대한 설명을 추가함

@return: 반환 값에 대한 설명을 추가함

@constructor: 본 생성자에 대한 설명을 추가함

@see: 다른 요소에 대한 참조를 추가함

@throws class, @exception class: 예외 상황에 대한 설명을 추가함

Dokka

다음으로 Dokka를 이용한 html형태의 Kdoc 문서화

1. project:build.gradle

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