[Effective Java] 메서드가 던지는 모든 예외를 문서화하라

메서드가 던지는 예외는 그 메서드를 올바로 사용하는 데 아주 중요한 정보다. 따라서 각 메서드가 던지는 예외에 대해 문서화해야 한다.

검사 예외 문서화

• 검사 예외는 항상 따로따로 선언한다.
• 자바독의 @throws 태그를 사용한다.

비검사 예외 문서화

• 비검사 예외도 검사 예외처럼 정서껏 문서화해두면 좋다. 비검사 예외는 일반적으로 프로그래밍 오류를 의미하며, 자신이 일으킬 수 있는 오류들이 무엇인지 알려주면 프로그래머는 자연스럽게
  해당 오류가 나지 않도록 코딩하게 된다.
• 비검사 예외는 throws 목록에 넣지 않는다.

클래스 레벨 예외

한 클래스에 정의된 많은 메서드가 같은 이유로 같은 예외를 던진다면 그 예외를 클래스 설명에 추가하는 방법도 있다.

• e.g ) NullPointerException