코틀린 문서화

코틀린도 자바독처럼 문서화 주석 형식이 있다. 이를 KDoc이라 부른다.

KDoc도 /**로 시작하며 특정 선언을 문서화 할때 @로 시작하는 태그를 사용한다. 자바독과 케이도그이 가장 큰 차이는 HTML 대신 마크다운을 사용한다는 점이다. 케이독의 몇가지 관례를 소개한다.

/**
* 두 수 [a]와 [b]의 합계를 계산한다.
*/
fun sum(a: Int, b: Int) = a + b

케이독 주석안에서 선언을 참조하고 싶으면 대괄호 사이에 이름을 넣으면 된다. 이 예제에서는 파라미터를 언급했다. 그리고 연결한 링크에 이름을 붙이고 싶다면 대괄호를 두번 사용하면 된다.

/**
* 두 수 [a]와 [숫자형] [kotlin.Int]의 합계를 계산한다.
*/
fun sum(a: Int, b: Int) = a + b

코틀린의 문서 생성 도구는 도카Dokka이다. org.jetbrains.dokka