Item 74 : 메소드가 던지는 모든 예외를 문서화하라

• 메소드가 던지는 예외에 하나하나를 문서화하는데 충분한 시간을 써야한다.

 

 

검사예외는 항상 따로따로 선언하고,

각 예외가 발생하는 상황을 자바독의 @throws 태그를 사용하여 정확히 문서화하자.

 

 

• 공통 상위 클래스 하나로 뭉뚱그려 선언하는 일을 삼가자.
• main 메소드를 제외하고 Exception이나 Throwable을 그냥 선언해서는 안된다.
• 자바 언어가 요구하는 것은 아니지만 비검사 예외도 검사 예외처럼 정성껏 문서화해두면 좋다.

• public 메소드라면 필요한 전제조건을 문서화해야 하며 그 수단으로 가장 좋은것이 바로 비검사 예외들을 문서화하는 것이다.

https://puzzle-making.tistory.com/175

Item 56 : 공개된 API 요소에는 항상 문서화 주석을 작성하라

 

 

메소드가 던질 수 있는 예외를 각각 @throws 태그로 문서화하되,

비검사 예외는 메소드 선언의 throws 목록에 넣지 말자

• 검사냐 비검사냐에 따라 사용자의 행동강령이 달라지기 때문에 둘을 확실히 구분하자.
• 한 클래스에 정의된 메소드가 같은 이유로 같은 예외를 던진다면 클래스 설명에 추가해도 좋다.