API를 쓸모 있게 하려면 잘 작성된 문서도 곁들여야 한다. 전통적으로 API 문서는 사람이 직접 작성하므로 코드가 변경되면 매번 함께 수정해줘야 하는데, 자바에서는 자바독(Javadoc)이라는 유틸리티가 이 귀찮은 작업을 도와준다. 자바독은 소스코드 파일에서 문서화 주석(doc comment, 자바독 주석)이라는 특수한 형태로 기술된 설명을 추려 API 문서로 변환해준다.
문서화 주석을 작성하는 규칙은 공식 언어 명세에 속하진 않지만 자바 프로그래머라면 응당 알아야 하는 업계 표준 API라 할 수 있다. 자바 버전이 올라가며 추가된 중요한 자바독 태그로는 자바 5의 @literal과 @code, 자바 8의 @implSpec, 자바 9의 @index를 꼽을 수 있다.
여러분의 API를 올바로 문서화하려면 공개된 모든 클래스, 인터페이스, 메소드, 필드 선언에 문서화 주석을 달아야 한다. 직렬화할 수 있는 클래스라면 직렬화 형태에 관해서도 적어야 한다. 기본 생성자에는 문서화 주석을 달 방법이 없으니 공개 클래스는 절대 기본 생성자를 사용하면 안 된다. 한편, 유지보수까지 고려한다면 대다수의 공개되지 않은 클래스, 인터페이스, 생성자, 메소드, 필드에도 문서화 주석을 달아야 할 것이다.
메소드용 문서화 주석에는 해당 메소드와 클라이언트 사이의 규약을 명료하게 기술해야 한다. 상속용으로 설계된 클래스의 메소드가 아니라면 무엇을 하는지를 기술해야 한다. 문서화 주석에는 클라이언트가 해당 메소드를 호출하기 위한 전제조건(precondition)과, 메소드가 성공적으로 수행된 후에 만족해야 하는 사후조건(postcondition)도 모두 나열해야 한다. 또한 전제조건과 사후조건뿐만 아니라 사후조건으로 명확히 나타나지는 않지만 시스템의 상태에 어떠한 변화를 가져오는 부작용도 문서화해야 한다. 일반적으로 전제조건은 @throws 태그로 비검사 예외를 선언하여 암시적으로 기술하거나, @param 태그를 이용해 그 조건에 영향받는 매개변수에 기술할 수도 있다.
메소드의 계약(contract)을 완벽히 기술하려면 모든 매개변수에 @param 태그를, 반환 타입이 void가 아니라면 @return 태그를, 발생할 가능성이 있는 검사든 비검사든 모든 예외에 @throws 태그를 달아야 한다. 관례상 @param 태그와 @return 태그의 설명은 해당 매개변수가 뜻하는 값이나 반환값을 설명하는 명사구를 쓰고, 드물게는 명사구 대신 산술 표현식을 쓰기도 한다.
자바독 유틸리티는 문서화 주석을 HTML로 변환하므로 문서화 주석 안의 HTML 요소들이 최종 HTML 문서에 반영된다. 드물기는 하지만 자바독 설명에 HTML 표(table)까지 집어넣는 프로그래머도 있다.
{@code} 태그의 효과는 두 가지인데, 태그로 감싼 내용을 코드용 폰트로 렌더링하고, 태그로 감싸 내용에 포함된 HTML 요소나 다른 자바독 태그를 무시한다. 두 번째 효과 덕에 HTML 메타문자인 < 기호 등을 별다른 처리 없이 바로 사용할 수 있다. 문서화 주석에 여러 줄로 된 코드 예시를 넣으려면 {@code} 태그를 다시 <pre> 태그로 감싼 <pre>{@code ... 코드 ...}</pre> 형태로 쓰면 된다.
관례상, 인스턴스 메소드의 문서화 주석에 쓰인 "this"는 호출된 메소드가 자리하는 객체를 가리킨다.
클래스를 상속용으로 설계할 때는 자기사용 패턴(self-use pattern)에 대해서도 문서에 남겨 다른 프로그래머에게 그 메소드를 올바로 재정의하는 방법을 알려줘야 한다. 자기사용 패턴은 자바 8에 추가된 @implSpec 태그로 문서화한다. 일반적인 문서화 주석은 해당 메소드와 클라이언트 사이의 계약을 설명하는 반면, @implSpec 주석은 해당 메소드와 하위 클래스 사이의 계약을 설명하여, 하위 클래스들이 그 메소드를 상속하거나 super 키워드를 이용해 호출할 때 그 메소드가 어떻게 동작하는지를 명확히 인지하고 사용하도록 해줘야 한다.
API 설명에 <, >, & 등의 HTML 메타문자를 포함시키려면 특별한 처리를 해줘야 함을 잊지 말자. 가장 좋은 방법은 {@literal} 태그로 감싸는 것인데, 이 태그는 HTML 마크업이나 자바독 태그를 무시하게 해준다. 앞서 본 {@code} 태그와 비슷하지만 코드 폰트로 렌더링하지는 않는다.
각 문서화 주석의 첫 번째 문장은 해당 요소의 요약 설명(summary description)으로 간주된다. 요약 설명은 반드시 대상의 기능을 고유하게 기술해야 한다. 헷갈리지 않으려면 한 클래스(혹은 인터페이스) 안에서 요약 설명이 똑같은 멤버(혹은 생성자)가 둘 이상이면 안 된다. 다중정의된 메소드는 설명이 같은 문장으로 시작하는 게 자연스럽겠지만 문서화 주석에서는 허용되지 않으므로 다중정의 메소드가 있다면 특히 더 조심하자.
요약 설명에서는 마침표(.)에 주의해야 한다. 요약 설명이 끝나는 판단 기준은 처음 발견되는 {<마침표><공백><다음 문장 시작>} 패턴의 <마침표>까지다. 여기서 <공백>은 스페이스(space), 탭(tab), 줄바꿈(혹은 첫 번째 블록 태그)이며 <다음 문장 시작>은 '소문자가 아닌' 문자다. 해결책은 의도치 않은 마침표를 포함한 텍스트를 {@literal}로 감싸주는 것이다. 또한 자바 10부터는 {@summary}라는 요약 설명 전용 태그가 추가되어 이 태그를 써도 된다.
메소드와 생성자의 요약 설명은 해당 메소드와 생성자의 동작을 설명하는 주어가 없는 동사구여야 한다. 한편 클래스, 인터페이스, 필드의 요약 설명은 대상을 설명하는 명사절이어야 한다. 클래스와 인터페이스의 대상은 그 인스턴스이고, 필드의 대상은 필드 자신이다.
자바 9부터는 자바독이 생성한 HTML 문서에 검색(색인) 기능이 추가되어 광대한 API 문서들을 누비는 일이 한결 수월해졌다. 클래스, 메소드, 필드 같은 API 요소의 색인은 자동으로 만들어지며, 원한다면 {@index} 태그를 사용해 여러분의 API에서 중요한 용어를 추가로 색인화할 수 있다.
문서화 주석에서 제네릭, 열거 타입, 애너테이션은 특별히 주의해야 한다. 제네릭 타입이나 제네릭 메소드를 문서화할 때는 모든 타입 매개변수에 주석을 달아야 한다. 열거 타입을 문서화할 때는 상수들에도 주석을 달아야 한다. 열거 타입 자체와 그 열거 타입의 public 메소드도 물론이다. 애너테이션 타입을 문서화할 때는 멤버들에도 모두 주석을 달아야 한다. 애너테이션 타입 자체도 물론이다. 필드 설명은 명사구로, 애너테이션 타입의 요약 설명은 애너테이션을 단다는 것이 어떤 의미인지를 설명하는 동사구로 한다.
패키지를 설명하는 문서화 주석은 package-info.java 파일에 작성한다. 이 파일은 패키지 선언을 반드시 포함해야 하며 패키지 선언 관련 애너테이션을 추가로 포함할 수도 있다. 자바 9부터 지원하는 모듈 시스템도 이와 비슷한데, 모듈 시스템을 사용하다면 모듈 관련 설명은 module-info.java 파일에 작성하면 된다.
API 문서화에서 자주 누락되는 설명이 두 가지 있으니, 바로 스레드 안전성과 직렬화 가능성이다. 클래스 혹은 정적 메소드가 스레드 안전하든 그렇지 않든, 스레드 안전 수준을 반드시 API 설명에 포함해야 한다. 또한, 직렬화할 수 있는 클래스라면 직렬화 형태도 API 설명에 기술해야 한다.
자바독은 메소드 주석을 '상속'시킬 수 있다. 문서화 주석이 없는 API 요소를 발견하면 자바독이 가장 가까운 문서화 주석을 찾아준다. 또한 {@inheritDoc} 태그를 사용해 상위 타입의 문서화 주석 일부를 상속할 수 있다.
비록 공개된 모든 API 요소에 문서화 주석을 달았더라도, 여러 클래스가 상호작용하는 복잡한 API라면 문서화 주석 외에도 전체 아키텍처를 설명하는 별도의 설명이 필요할 때가 가끔 있다. 이런 설명 문서가 있다면 관련 클래스나 패키지의 문서화 주석에서 그 문서의 링크를 제공해주면 좋다.
위에 설명한 지침을 잘 따른다면 API를 깔끔히 설명하는 문서를 작성할 수 있다. 하지만 정말 잘 쓰인 문서인지를 확인하는 유일한 방법은 자바독 유틸리티가 생성한 웹페이지를 읽어보는 길뿐이다. 다른 사람이 사용할 API라면 반드시 모든 API 요소를 검토하라. 프로그램을 테스트하면 어김없이 수정할 코드가 나오듯이, 생성된 API 문서를 읽어보면 고쳐 써야 할 주석이 눈에 들어오게 마련이다.
문서화 주석은 여러분 API를 문서화하는 가장 훌륭하고 효과적인 방법이다. 공개 API라면 빠짐없이 설명을 달아야 한다. 표준 규약을 일관되게 지키자. 문서화 주석에 임의의 HTML 태그를 사용할 수 있음을 기억하라. 단, HTML 메타문자는 특별하게 취급해야 한다.