아이템[56]. 공개된 API 요소에는 항상 문서화 주석을 작성하라

API를 쓸모 있게 하려면 잘 작성된 문서도 곁들여야 합니다.

전통적으로 API 문서는 사람이 직접 작성하므로 코드가 변경되면 매번 함께 수정해줘야 하는데, 자바에서는 Javadoc이라는 유틸리티가 이 귀찮은 작업을 도와줍니다.

자바독은 소스코드 파일에서 문서화 주석이라는 특수한 형태로 기술된 설명을 추려 API 문서로 변환해줍니다.

문서화 주석을 작성하는 규칙은 공식 언어 명세에 속하진 않지만 자바 프로그래머라면 응당 알아야 하는 업계 표준 API라 할 수 있습니다.

여러분의 API를 올바로 문서화하려면 모든 클래스, 인터페이스, 메서드, 필드 선언에 문서화 주석을 달아야 합니다.

직렬화할 수 있는 클래스라면 직렬화 형태(아이템 87)에 관해서도 적어야 합니다.

문서화 주석이 없다면 자바독도 그저 공개 API 요소들의 '선언'만 나열해주는 게 전부입니다.

문서가 잘 갖춰지지 않은 API는 쓰기 헷갈려서 오류의 원인이 되기 쉽습니다.

기본 생성자에는 문서화 주석을 달 방법이 없으니 공개 클래스는 절대 기본 생성자를 사용하면 안 됩니다.

한편, 유지보수까지 고려한다면 대다수의 공개되지 않은 클래스, 인터페이스, 생성자, 메서드, 필드에도 문서화 주석을 달아야 할 것입니다.

공개 API만큼 친절하게 설명하진 않더라도 말입니다.

메서드용 문서화 주석에는 해당 메서드와 클라이언트 사이의 규약을 명료하게 기술해야 합니다.

상속용으로 설계된 클래스(아이템 19)의 메서드가 아니라면 (그 메서드가 어떻게 동작하는지가 아니라) 무엇을 하는지를 기술해야 합니다.

즉, how가 아닌 what을 기술해야 합니다.

문서화 주석에는 클라이언트가 해당 메서드를 호출하기 위한 전제조건을 모두 나열해야 합니다.

또한 메서드가 성공적으로 수행된 후에 만족해야 하는 사후조건도 나열해야 합니다.

일반적으로 전제조건은 @throws 태그로 비검사 예외를 선언하여 암시적으로 기술합니다.

비검사 예외 하나가 전제조건 하나와 연결되는 것입니다.

또한, @param 태그를 이용해 그 조건에 영향받는 매개변수에 기술할 수도 있습니다.

전제조건과 사후조건뿐만 아니라 부작용도 문서화해야 합니다.

부작용이란 사후조건으로 명확히 나타나지는 않지만 시스템의 상태에 어떠한 변화를 가져오는 것을 뜻합니다.

예컨대 백그라운드 스레드를 시작시키는 메서드라면 그 사실을 문서에 밝혀야 합니다.

메서드의 계약을 완벽히 기술하려면 모든 매개변수에 @param 태그를, 반환 타입이 void가 아니라면 @return 태그를, 발생할 가능성이 있는 모든 예외에 @throws 태그를(아이템 74) 달아야 합니다.

여러분이 따르는 코딩 표준에서 허락한다면 @return 태그의 설명이 메서드 설명과 같을 때 @return 태그를 생략해도 좋습니다.

관례상 @param 태그와 @return 태그의 설명은 해당 매개변수가 뜻하는 값이나 반환값을 설명하는 명사구를 씁니다.

드물게는 명사구 대신 산술 표현식을 쓰기도 합니다.

예가 궁금하면 BigInteger의 API 문서를 봅시다.

@thorws 태그의 설명은 if로 시작해 해당 예외를 던지는 조건을 설명하는 절이 뒤따릅니다.

역시 관례상 @param, @return, @thorws 태그의 설명에는 마침표를 붙이지 않습니다. ⇒ 한글이면 붙여줌

다음은 이상의 규칙을 모두 반영한 문서화 주석의 예입니다.

/**
     * 이 리스트에서 지정한 위치의 원소를 반환한다.
     * 
     * <p> 이 메서드는 상수 시간에 수행됨을 보장하지 <i>않는다.</i>. 구현에 따라
     * 원소의 위치에 비례해 시간이 걸릴 수도 있다. </p>
     * 
     * @param index 반환할 원소의 인덱스; 0 이상이고 리스트 크기보다 작아야 한다.
     * @return 이 리스트에서 지정한 위치의 원소
     * @throws IndexOutOfBoundsException index가 범위를 벗어나면,
     *      즉, ({@code index < 0 || index >= this.size()})이면 발생한다.
     */
E get(int index);

문서화 주석에 HTML 태그를 쓴 점에 주목합시다.

자바독 유틸리티는 문서화 주석을 HTML로 변환하므로 문서화 주석 안의 HTML 요소들이 최종 HTML 문서에 반영됩니다.

드물기는 하지만 자바독 설명에 표(table)까지 집어넣는 프로그래머도 있습니다.

@throws 절에 사용한 {@code} 태그도 살펴봅시다.

이 태그의 효과는 두 가지입니다.

1. 태그로 감싼 내용을 코드용 폰트로 렌더링합니다.
2. 태그로 감싼 내용에 포함된 HTML 요소나 다른 자바독 태그를 무시합니다.

두 번째 효과 덕에 HTML 메타문자인 < 기호 등을 별다른 처리 없이 바로 사용할 수 있습니다.

문서화 주석에 여러 줄로 된 코드 예시를 넣으려면 {@code} 태그를 다시 <pre> 태그로 감싸면 됩니다.

다시 말해 <pre>{@code ... 코드 ...} </pre> 형태로 쓰면 됩니다.

이렇게 하면 HTML의 탈출 메타문자를 쓰지 않아도 코드의 줄바꿈이 그대로 유지됩니다.

단, @ 기호에는 무조건 탈출문자를 붙여야 하니 문서화 주석 안의 코드에서 애너테이션을 사용한다면 주의하기 바랍니다.

마지막으로, 영문 문서화 주석에서 쓴 "this list"라는 단어에 주목합시다.

관례상, 인스턴스 메서드의 문서화 주석에 쓰인 "this"는 호출된 메서드가 자리하는 객체를 가리킵니다.

아이템 15에서 이야기했듯, 클래스를 상속용으로 설계할 때는 자기사용 패턴에 대해서도 문서에 남겨 다른 프로그래머에게 그 메서드를 올바른 재정의하는 방법을 알려줘야 합니다.

자기사용 패턴은 자바 8에 추가된 @implSpec 태그로 문서화합니다.

다시 말하지만, 일반적인 문서화 주석은 해당 메서드와 클라이언트 사이의 계약을 설명합니다.

반면, @implSpec 주석은 해당 메서드와 하위 클래스 사이의 계약을 설명하여, 하위 클래스들이 그 메서드를 상속하거나 super 키워드를 이용해 호출할 때 그 메서드가 어떻게 동작하는지를 명확히 인지하고 사용하도록 해줘야 합니다.

/**
     * 이 컬렉션이 비었다면 true를 반환한다.
     *
     * @implSpec
     * 이 구현은 {@code this.size() == 0}의 결과를 반환한다.
     * 
     * @return 이 컬렉션이 비었다면 true, 그렇지 않으면 false
*/
public boolean isEmpty() { ... }

자바 11까지도 자바독 명령줄에서 -tag "implSpec:a:Implementation Requirements:" 스위치를 켜주지 않으면 @implSpec 태그를 무시해버립니다.

다음 버전에서는 기본값으로 적용되길 바랍니다.

API 설명에 <, >, & 등의 HTML 메타문자를 포함시키려면 특별한 처리를 해줘야 함을 잊지 맙시다.

가장 좋은 방법은 {@literal} 태그로 감싸는 것입니다.

이 태그는 HTML 마크업이나 자바독 태그를 무시하게 해줍니다.

앞서 본 {@code} 태그와 비슷하지만 코드 폰트로 렌더링하지는 않습니다.

예를 살펴봅시다.

* {@literal |r| < 1}이면 기하 수열이 수렴한다.

이 주석은 **|r| < 1 이면 기하 수열이 수렴한다.**로 변환됩니다.

사실 < 기호만 {@literal}로 감싸도 결과는 똑같지만, 그렇게 하면 코드에서의 문서화 주석을 읽기 어려워집니다.

문서화 주석은 코드에서건 변환된 API 문서에서건 읽기 쉬워야 한다는 게 일반 원칙입니다.

양쪽을 만족하지 못하겠다면 API 문서에서의 가독성을 우선합니다.

각 문서화 주석의 첫 번째 문장은 해당 요소의 요약 설명으로 간주됩니다.

이번 아이템 첫 예시 코드의 "이 리스트에서 지정한 위치의 원소를 반환한다" 라는 문장이 여기에 속합니다.

요약 설명은 반드시 대상의 기능을 고유하게 기술해야 합니다.

헷갈리지 않으려면 한 클래스(혹은 인터페이스) 안에서 요약 설명이 똑같은 멤버(혹은 생성자)가 둘 이상이면 안 됩니다.

다중정의된 메서드가 있다면 특히 더 조심합시다.

다중정의된 메서드들의 설명은 같은 문장으로 시작하는 게 자연스럽겠지만 문서화 주석에는 허용되지 않습니다.

요약 설명에서는 마침표(.)에 주의해야 합니다.

요약 설명이 끝나는 판단 기준은 처음 발견되는 <마침표>, <공백>, <다음 문장 시작 > 패턴의 <마침표>까지입니다.

여기서 <공백>은 스페이스, 탭, 줄바꿈을 의미합니다.

<다음 문장 시작>은 '소문자가 아닌' 문자입니다.

가장 좋은 해결책은 의도치 않은 마침표를 포함한 텍스트를 {@literal}로 감싸주는 것이빈다.

자바 10부터는 {@summary}라는 요약 설며 태그가 추가되었다고 합니다.

"요약 설명이란 문서화 주석의 첫 문장이다"라고 말하면 살짝 오해의 소지가 있습니다.

주석 작성 규약에 따르면 요약 설명은 완전한 문장이 되는 경우가 드물기 때문입니다.

메서드와 생성자의 요약 설명은 해당 메서드와 생성자의 동작을 설명하는 (주어가 없는) 동사구여야 합니다.

다음 예를 봅시다.

• ArrayList(int initialCapacity) : Constructs an empty list with the specified initial capacity.
• Colleciton.size() : Returns the number of elements in this collection.

이 예에서처럼 2인칭 문장이 아닌 3인칭 문장으로 써야 합니다. ⇒ 한글에선 차이 없음

한편 클래스, 인터페이스, 필드의 요약 설명은 대상을 설명하는 명사절이어야 합니다.

클래스와 인터페이스의 대상은 그 인스턴스이고, 필드의 대상은 필드 자신입니다.

다음 예를 봅시다.

• Instant : An instantaneous point on the time-line.
• Math.PI: The double value that is closer than any other to pi, the ratio of the circumference of a circle to its diameter.

자바 9부터는 자바독이 생성한 HTML 문서에 색인 기능이 추가되어 광대한 API 문서들을 누비는 일이 한결 수월해졌습니다.

API 문서 페이지 오른쪽 위에 있는 검색창에 키워드를 입력하면 관련 페이지들이 드롭다운 메뉴로 나타납니다.

클래스, 메서드, 필드 같은 API 요소의 색인은 자동으로 만들어지며, 원한다면 {@Index} 태그를 사용해 여러분의 API에서 중요한 용어를 추가로 색인화할 수 있습니다.

다음 예처럼 단순히 색인으로 만들 용어를 태그로 감싸면 됩니다.

* This method compies with the {@index IEEE 754} standard.

문서화 주석에서 제네릭, 열거 타입, 애너테이션은 특별히 주의해야 합니다.

제네릭 타입이나 제네릭 메서드를 문서화할 때에는 모든 타입 매개변수에 주석을 달아야 합니다.

/**
     * 키와 값을 매핑하는 객체. 맵은 키를 중복해서 가질 수 없다.
     * 즉, 키 하나가 가리킬 수 있는 값은 최대 1개다.
     *
     * @param <K> 이 맵이 관리하는 키의 타입
     * @param <V> 매핑된 값의 타입
*/
public interface Map<K,V> {...}

열거 타입을 문서화할 때는 상수들에도 주석을 달아야 합니다.

열거 타입 자체와 그 열거 타입의 public 메서드도 물론입니다.

설명이 짧다면 주석 전체를 한 문장으로 써도 됩니다.

/**
  * 심포니 오케스트라의 악기 세션
*/
public enum OrchestraSection {
        /** 플루트, 클라리넷, 오보 같은 목관악기. */
        WOODWIND,

        /** 프렌치 호른, 트럼펫 같은 금관악기. */
        BRASS,

        /** 탐파니, 심벌즈 같은 타악기. */
        PERCUSSION,

        /** 바이올린, 첼로 같은 현악기. */
        STRING;
    }
}

애너테이션 타입을 문서화할 때는 멤버들에도 모두 주석을 달아야 합니다.

애너테이션 타입 자체도 물론입니다.

필드 설명은 명사구로 합니다.

애너테이션 타입의 요약 설명은 프로그램 요소에 이 애너테이션을 단다는 것이 어떤 의미인지를 설명하는 동사구로 합니다.

한글로 쓴다면 동사로 끝나는 평범한 문장이면 됩니다.

/**
     * 이 애너테이션이 달린 메서드는 명시한 예외만 던져야만 성공하는
     * 테스트 메서드임을 나타낸다.
     */
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.METHOD)
    public @interface ExceptionTest {
        /**
         * 이 애너테이션을 단 테스트 메서드가 성공하려면 던져야 하는 예외.
         * (이 클래스의 하위 타입 예외는 모두 허용된다.)
         */
        Class<? extends Throwable> value();
}

패키지를 설명하는 문서화 주석은 package-info.java 파일에 작성합니다.

이 파일은 패키지 선언을 반드시 포함해야 하며 패키지 선언 관련 애너테이션을 추가로 포함할 수도 있습니다.

자바 9부터 지원하는 모듈 시스템(아이템 15)도 이와 비슷합니다.

모듈 시스템을 사용한다면 모듈 관련 설명은 module-info.java 파일에 작성하면 됩니다.

API 문서화에서 자주 누락되는 설명이 두 가지 있습니다.

바로 스레드 안전성과 직렬화 가능성입니다.

클래스 혹은 정적 메서드가 스레드 안전하든 그렇지 않든, 스레드 안전 수준은 반드시 API 설명에 포함해야 합니다. (아이템 82)

또한, 직렬화할 수 있는 클래스라면 직렬화 형태도 API 설명에 기술해야 합니다. (아이템 87)

자바독은 메서드 주석을 상속시킬 수 있습니다.

문서화 주석이 없는 API 요소를 발견하면 자바독이 가장 가까운 문서화 주석을 찾아줍니다.

이 때 상위 클래스보다 그 클래스가 구현한 인터페이스를 먼저 찾습니다.

또한 {@inheritDoc} 태그를 사용해 상위 타입의 문서화 주석 일부를 상속할 수 있습니다.

클래스는 자신이 구현한 인터페이스의 문서화 주석을 재사용할 수 있다는 뜻입니다.

이 기능을 활용하면 거의 똑같은 문서화 주석 여러 개를 유지보수하는 부담을 줄일 수있지만, 사용하기 까다롭고 제약도 조금 있습니다.

문서화 주석에 관해 언급해둘 주의사항이 하나 더 있습니다.

비록 공개된 모든 API 요소에 문서화 주석을 달았더라도, 이것만으로는 충분하지 않을 때가 있습니다.

여러 클래스가 상호작용하는 복잡한 API라면 문서화 주석 외에도 전체 아키텍철르 설명하는 별도의 설명이 필요할 때가 왕왕 있습니다.

이런 설명 문서가 있다면 관련 클래스나 패키지의 문서화 주석에서 그 문서의 링크를 제공해주면 좋습니다.

자바독은 프로그래머가 자바독 문서를 올바르게 작성했는지 확인하는 기능을 제공하며, 이번 아이템에서 소개한 권장사항 중 상당수를 검사해줍니다.

자바 7에서는 명령줄에서 -Xdoclint 스위치를 켜주면 이 기능이 활성화되고, 자바 8부터는 기본으로 작동합니다.

체크스타일 같은 IDE 플러그인을 사용하면 더 완벽하게 검사됩니다.

자바독이 생성한 HTML 파일을 HTML 유효성 검사기로 돌리면 문서화 주석의 오류를 한층 더 줄일 수 있습니다.

HTML 유효성 검사기는 잘못 사용한 HTML 태그를 찾아줍니다.

로컬에 내려받아 사용할 수 있는 설치형 검사기, 웹에서 바로 사용할 수 있는 W3C 마크업 검사 서비스가 있습니다.

자바 9와 10의 자바독은 기본적으로 HTML 4.01 문서를 생성하지만, 명령줄에서 -html5 스위치를 켜면 HTML 5 버전으로 만들어줍니다.

이번 아이템에서 설명한 지침을 잘 따른다면 여러분의 API를 깔끔히 설명하는 문서를 작성할 수 있습니다.

하지만 정말 잘 쓰인 문서인지를 확인하는 유일한 방법은 자바독 유틸리티가 생성한 웹페이지를 읽어보는 길뿐입니다.

다른 사람이 사용할 API라면 반드시 모든 API 요소를 검토합니다.

프로그램을 테스트하면 어김없이 수정할 코드가 나오듯이, 생성된 API 문서를 읽어보면 고쳐 써야 할 주석이 눈에 들어오게 될 것입니다.

정리

• 문서화 주석은 여러분 API를 문서화하는 가장 훌륭하고 효과적인 방법이다.
• 공개 API라면 빠짐없이 설명을 달아야 한다.
• 표준 규약을 일관되게 지키자.
• 문서화 주석에 임의의 HTML 태그를 사용할 수 있음을 기억하라.
• 단, HTML 메타문자는 특별하게 취급해야 한다.