본문 바로가기

개발이야기/Effective Java

[Effective Java]메서드에서 던져지는 모든 예외에 대해 문서를 남겨라



메서드를 올바르게 사용하려면, 메서드에서 던져지는 예외에 대한 설명이 문서에 있어야 한다. 따라서 문서화는 아주 중요하다.(당연한 이야기)


1. Javadoc @throws 태그를 사용해서 정확하게 밝히기

2. 같은 이유로 동일한 예외를 던지는 메서드가 많으면 메서드마다 문서를 만들지말고, 예외에 대한 문서를 클래스의 문서화 주석(documentation comment)에 남기자.


단순하지만 명확한 결론


결론 : 메서드가 던질 가능성이 있는 모든 예외를 문서로 남기자