오딩이

검사 예외든, 비검사 예외든, 추상 메서드든, 구체 메서드든 메서드가 던질 가능성이 있는 모든 예외를 문서화하라. 🐱‍👤 검사예외 검사 예외는 항상 따로따로 선언하고, 각 예외가 발생하는 상황을 자바독의 @throws 태그를 사용하여 정확히 문서화하자. 만약, 공통 상위 클래스 하나로 예외를 뭉뚱그려 선언한다면 메서드 사용자에게 각 예외에 대처할 수 있는 힌트를 주지 못할뿐더러, 같은 맥락에서 발생할 여지가 있는 다른 예외들까지 삼켜버릴 수 있어 API 사용성을 크게 떨어뜨린다. (하지만 오직 JVM만이 호출하는 main 메서드는 예외다. Exception을 던지도록 선언해도 괜찮음) 🐱‍💻 비검사예외 자바 언어가 요구하는 것은 아니지만, 비검사 예외도 검사 예외처럼 문서화해두면 도움이 된다. 잘 정비된..