[코틀린 공식문서] KDoc 문서화 코드

해당 블로깅은 코틀린 공식문서의 kotlin공식문서 KDoc를 번역하며 학습한 내용입니다.

학습중임에 따라 이해하는데 도움이 되는 부분들을 추가되고 의역된 부분이 있습니다. 혹시 잘못된 설명이 있다면 얼마든지 제보해주세요.

---

코틀린코드 문서화에 사용되는 언어를 KDoc이라고 한다. KDoc 은 Javadoc의 블록 태그 구문(+코틀린의 특정 구조를 지원하도록 확장)과 Markdown을 결합하여 마크업을 수행한다.

코틀린의 문서화 엔진 Dokka
html, markdown, javadoc의 형태로 출력이 된다.
하지만 현재 시점에서 md와 javadoc은 알파 버전이라 버그가 존재 할 수 있음

문서화를 진행할 경우, 문서화 하여 출력할 수 있을 뿐 아니라, IDE를 통하여 코드 사용 시에도 도움을 받을 수 있다

Blog tags	설명
@param[name] description @param name description	class, function등의 매개변수 이름. 두가지 형식으로 모두 사용이 가능하다.
@return	function의 반환값
@constructor	클래스의 primary constructor(기본 생성자)
@receiver	extenstion함수의 reveiver
@property name	클래스의 property에 대한 문서화 기본 생성자에서 선언된 property를 문서화 하는데 사용한다.
@throws class @exception class	메서드에 의해 발생 가능한 예외(exception)에 대한 설명
@sample identifier	함수가 어떻게 사용되는지에 대한 예시 작성
@author	작성자
@since	작성된 시점
@suppress	해당 요소를 생성된 문서에서 제외시키고 싶을 때 사용

인라인에서는 일반 마크다운 문법을 지원한다.

추가로 읽어보면 좋을 문서: kotlin documentaion (kDoc) guidelines