규칙 62 - 메서드에서 던져지는 모든 예외에 대해 문서를 남겨라.

JAVA/Effective Java|2018. 6. 1. 23:17

메서드를 올바르게 사용하려면 메서드에서 던져지는 예외에 대한 설명이 문서에 있어야 한다.


그리고 


메서드가 던질수있는 모든 무점검 예외까지 선언할 필요는 없지만 점검지점 예외들과 마찬가지로주의해서 문서로 남겨놓으면 좋다.


특히 Javadoc @throws 태그를 사용해서 메서드에서 발생 가능한 모든 무점검 예외에 대한 문서를 남겨야 한다. 하지만 메서드 선언부의 throws 뒤에 무점검 예외를 나열하지는 말아야 한다.





요약하자면 메서드가 던질 가능성이 있는 모든 예외를 문서로 남겨라. 

점검지점 예외, 무점검 예외도 남겨라.



이를 지키지 않으면 해당 API를 사용하는 다른사람들이 효과적으로 사용하는게 어려워진다.




출처 : 조슈아 블로크, 『 Effective Java 2/E』, 이병준 옮김, 인사이트(2014.9.1), 규칙62 인용

댓글()