이펙티브 자바

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

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

• 메서드 주석에서는 HOW가 아닌 WHAT을 기술해야 된다.

• 한클래스 안에 설명이 똑같은 맴버가 둘이상이면 안된다.

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

• 열거타입을 문서화 할때 상수에도 주석을 달아야 된다.

• 정적메서드의 쓰레드 안전수준은 안전하던 안하던 다 주석에 명시 해야 된다.

참조

---