기록이 힘이다.

[이펙티브 자바] 74. 메서드가 던지는 모든 예외를 문서화하라 본문

JAVA

[이펙티브 자바] 74. 메서드가 던지는 모든 예외를 문서화하라

dev22 2023. 4. 26. 07:22
728x90

검사 예외는 항상 따로따로 선언하고, 각 예외가 발생하는 상황을 자바독의 @throws 태그를 사용하여 정확히 문서화하자.

메서드가 던질수 있는 예외를 각각 @throws 태그로 문서화하되, 비검사 예외는 메서드 선언의 throws 목록에 넣지 말자.

 

검사냐 비검사냐에 따라 API 사용자가 해야 할 일이 달라지므로 이 둘을 확실히 구분해주는 게 좋다.

 

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