Javadoc 작성기

최근에 Jetty기반의 서버를 하나 개발하게 되었다. 릴리스를 할 수 있는 수준까지 개발이 되었고, 진척이 됨에 따라 중간중간에 주석으로만 남겨두거나 간단하게만 적었던 설명들을 Javadoc을 이용해서 구체화하게 되었다. Javadoc은 소스코드 주석을 이용해 API 문서를 만드는 유틸리티고, 지금까지도 Java 문서화하면 먼저 나오는 단어들 중 하나일만큼 유명하다. 유명하고 자주 봐서 그런지 그만큼 사용하기 편한 것 같아서 나도 이용하게 되었다. 이번 글에서는 내가 어떻게 Javadoc을 사용했는지 남겨본다.

1. Javadoc이 필요한가?

일단 소스코드 상으로 보는 문서가 아니라 페이지 형태로 정리된 문서는 내가 원하는 클래스를 찾기 편하게 만든다고 생각한다. JDK API reference들도 보면 javaadoc으로 만들어졌는데, 패키지와 클래스가 왼쪽 메뉴에 있다. 이를 통해서 원하는 이름의 클래스를 쉽게 찾을 수 있고, 클래스를 쉽게 찾으면 원하는 인터페이스를 찾는데 더 도움이 된다고 생각한다.

또한 소스코드 상에서도 Javadoc은 // 으로 적는 주석보다 낫다고 생각한다. @link 같은 태그들로 다른 인터페이스를 연결해두면 분석을 위해 소스를 보는 시간이 크게 줄어든다고 생각한다.

2. 기본적인 사용법

문서화할 주석을 다는 경우에는 /** */ 안에 내용이 들어가 있으면 된다. 특별한 내용을 다룰 때는 @로 시작하는 태그들을 사용한다. 주로 사용하는 태그는 @link, @param, @throws 정도이고, 그 외에도 사용되는 태그들에는 @author, @deprecated, @since, {@code} 정도가 있다.

Orcale에서 제공하는 Javadoc guide에는 어떻게 작성하는지 대략적인 가이드가 나와 있다. 가이드와 나의 경험을 섞어서 요약하자면 아래와 같다.

  • 첫 줄에는 주석 시작을 나타내는 문자(/**)
  • 첫 문장은 현재 작성하는 메서드에 대한 요약.

    • 메서드 요약 테이블과 인덱스에 위치됨
    • 메스드 요약 같은 경우에는 두 줄까지 나오더라.
  • {@link URL} 형식으로 참조하게 할 링크를 명시하라는데, ${className}#${interfaceName} 형식으로 작성하면 Javadoc을 생성했을 때 해당 인터페이스의 링크가 걸린다.
  • 만약 할 말이 많아서 문단이 구분되어야 한다면 구분되는 라인에 <p> 태그를 넣으면 된다. newline을 넣고 싶다면 <br> 로 넣을 수 있다.
  • 설명과 태그 사이에는 공백 라인을 하나 넣을 것
  • @ 으로 시작하는 라인이 나오면 설명 부분은 끝나게 된다고 한다. @ 로 시작하는 라인 이후에 다시 설명 부분이 나오거나 할 수는 없다고 한다.
  • 마지막 라인은 주석이 끝났음을 나타내는 문자(*/)

그래서 예시를 들자면 아래와 같다.

/**
 * This controls certian functions.
 * Parameter argument should satisfy certain contains. 
 * <p>
 * Other paragraphs can also be made. 
 *
 * @param   parameter   object giving something of something
 * @return              object of the result processed by the given parameter
 * @see     {@link SomeClass#someMethod}
*/


public SomeClass someMethod(SomeOhterClass parameter) {
    // do something...
    return new SomeClass().someSetter(something);
}

3. 조그마한 이슈들

3-1. 커스텀 태그

Spark나 Javalin같은 웹 프레임워크들을 사용할 때는 엔드포인트들을 구현하게 된다. 예를 들면 (GET)/api/message/send 엔드포인트의 요청을 받아서 처리하는 엔드포인트를 messageSend 라는 변수로 구현했을 때 messageSend 라는 변수의 설명을 달아야 하는데, 이 변수는 엔드포인트의 구현이라는 설명을 하고 싶을 수 있다. 이럴 경우 @Endpoint /api/message/send 와 같은 태그를 사용하면 어떨까? 하는 생각을 할 수 있는데, @Endpoint는 Javadoc에서 기본적으로 제공하는 태그가 아니다.

위와 같이 커스텀 태그를 사용하고 싶으면 Javadoc을 실행할 때 옵션에 커스텀태그에 대한 명시를 해주면 된다. -tag custom.${tag_name}:${Xaoptcmf}:"${tag_head}" 형식으로 사용할 수 있다. 소스코드 상에서 @tag_name 이라고 명시하면 tag_head 라는 제목의 태그로 바뀌는데, Xaoptcmf 의 속성을 가진다는 뜻이다. Xaoptcmf 중 하나의 글자가 들어가는데, 각 글자가 의미하는 바는 아래와 같다.

  • X (태그 무효화)
  • a (모든 위치)
  • o (개요)
  • p (패키지)
  • t (형태 : 클래스 및 인터페이스)
  • c (생성자)
  • m (메서드)
  • f (필드)

3-2. 인코딩

보통 Javadoc을 만들 정도의 프로젝트는 사내 프로덕트이고, 보통의 한국 회사라면 구성원들은 대부분 한국어가 모국어이기 때문에 아무리 소스코드와 함께 작성한다지만 한국어로 Javadoc을 적는 경우가 다수이다. Javadoc의 경우 한국어로 적으면 생성이 제대로 안 될 수 있다. unmappable character for encoding ASCII 같은 오류와 함께 생성이 실패하게 되는데, 이럴 경우 locale, charset, encoding, docencoding 옵션으로 한국어의 경우 UTF-8을 사용하도록 하면 된다.

-locale ko_KR -charset UTF-8 -encoding UTF-8 -docencoding UTF-8

4. 마무리

솔직히 말해서 요즘은 내가 가지고있는 소스코드, 빌드 자동화 툴(e.g. gradle) 등을 통해 받은 라이브러리 둘 다 IDE를 통하면 Javadoc을 충분히 볼 수 있다. 코딩을 하는 과정에서 설명이 필요한 메서드 등이 있으면 단축키를 통해 바로 이동할 수 있어서 이동한 지점에 있는 Javadoc 소스를 보면 된다. 또한 하나의 인터페이스에서 제공하는 메서드들의 목록을 볼 때도 쉽게 볼 수 있다. IntelliJ 같은 경우는 인터페이스 이름을 입력하고 . 을 누르면 드롭다운(?) 같은 리스트로 지원하는 함수 목록이 나열될 정도로 편리한 기능을 제공하고 있어서 Javadoc의 필요성이 많이 떨어졌을 수 있다. 그러나 여전히 Javadoc은 비교적 쉽게 소스에 대한 설명을 볼 수 있는 유용한 도구이니 필요한 경우 적극적으로 사용할 수 있을 것 같다고 생각한다.


Gyeongeon Yun
Written by@Gyeongeon Yun
소프트웨어, 서브컬쳐 등 취미 이야기를 주로 합니다.

GitHubTwitter