[이펙티브자바 3판] ITEM56. 공개된 API 요소에는 항상 문서화 주석을 작성하라

이번장의 핵심은...

문서화 주석은 여러분 API를 문서화하는 가장 훌륭하고 효과적인 방법입니다

공개 API라면 빠짐없이 설명을 달아야 합니다

표준 규약을 일관되게 지켜야 합니다

문서화 주석에 임의의 HTML 태그를 사용할 수 있음을 기억해야 합니다

단, HTML 메타문자를 특별하게 취급해야 합니다

---

자바독(Javadoc)

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

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

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

공개 클래스는 절대 기본 생성자를 사용하면 안 됩니다

(기본 생성자에는 주석을 달 방법이 없습니다)

 

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

1. how가 아닌 what을 기술합니다

2. 클라이언트가 해당 메서드를 호출하기 위한 전제조건을 모두 나열합니다

3. 성공적으로 수행된 후에 만족해야 하는 사후조건도 모두 나열합니다

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

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

6. 부작용도 문서화합니다

 

태그

1. 모든 매개변수에 @param 태그를 사용합니다

2. 반환 타입이 void가 아니면 @return을 사용합니다

→ param, return 태그의 설명은 해당 매개변수나 리턴값을 설명하는 명사구를 씁니다

3. 모든 예외에 @throws 태그를 사용합니다

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

5. 클래스를 상속용으로 설계할 때 @implSpec를 사용합니다 → 자기사용 패턴 (자바8추가)

→ 일반적인 문서화 주석은 해당 메서드와 클라이언트 사이의 계약을 설명하지만, @implSpec 주석은 해당 메서드와 하위 클래스 사이의 계약을 설명합니다

6. @literal 태그로 감싸면 API 설명에 <, >, & 등의 HTML 메타문자를 포함할 수 있습니다

7. @index 태그 (자바9추가) - API에서 중요한 용어를 추가로 색인화할 수 있습니다

8. @inheritDoc 태그 - 상위 타입의 문서화 주석 일부를 상속할 수 있습니다

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

 

 

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

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

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

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

 

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

 

API 문서화에 자주 누락되는 설명 2가지

1. 스레드 안정성

2. 직렬화 가능성

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

 

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

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