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

검사 예외

• 검사 예외는 항상 따로따로 선언하고, 각 예외가 발생하는 상황을 javadoc의 @throw 태그를 사용하여 정확히 문서화 하자
• 공통 상위 클래스 하나로 뭉뚱그려 선언하는 일은 삼가자

비검사 예외

• 비검사 예외도 검사 예외처럼 정성껏 문서화 해두면 좋다.
• 비검사 예외는 일반적으로 프로그래밍 오류를 뜻하는데, 자신이 일으킬 수 있는 오류들을 알려주면 사용하는 입장에서 도움이 된다.
• 메서드가 던질 수 있는 예외를 각각 @throws 태그로 문서화하되, 비검사 예외는 메서드 선언의 throws 목록에 넣지 말자 검사냐 비검사냐에 따라 사용자가 해야 할 일이 달라지므로 둘을 구분해주는것은 좋다.

현실적으로 불가능할때

• 비검사 예외는 문서화하기 불가능할 때도 있다. 예컨대 다른 사람이 작성한 클래스를 사용하는 메서드가 있을때, 발생가능한 모든 비검사 예외를 문서화 했다고 하더라도, 다른 사람이 작성한 클래스쪽에 수정사항이 있다면 문서화 되지 않은 새로운 비검사 예외를 전파하게 될것이다.

핵심 정리

메서드가 던질 가능성이 있는 모든 예외를 문서화하라.검사 예외든 비검사 예외든,추상 메서드든 구체 메서드든 모두 마찬가지다.문서화에는 자바독의 @throws 태그를 사용 하면 된다.검사 예외만 메서드 선언의 throws 문에 일일이 선언하고，비검사 예외는 메서드 선언에는 기입하지 말자.발생 가능한 예외를 문서로 남기지 않으면 다른 사람이 그 클래스나 인터페이스를 효과적으로 사용하기 어렵거나 심지어 불가능할 수도 있다.