<Effective Java> RULE 62 메서드에서 던져지는 모든 예외에 대해 문서를 남겨라

 

· 점검지정 예외는 독립적으로 선언하고, 해당 예외가 발생하는 상황은 javadoc @throws 태그를 사용해서 정확하게 밝혀라.

 

· javadoc @throws 태그를 사용해서 메서드에서 발생한 가능한 모든 무점검 예외에 대한 문서를 남겨라, 하지만 메서드 선언부의 throws뒤에 무점검 예외를 나열하진 마라.

 

· 동일한 예외를 던지는 메서드가 많다면 메서드마다 문서를 만드는 대신, 해당 예외에 대한 문서는 클래스의 문서 주석에 남겨도 된다.

ㄴ ex) 이 클래스에 있는 모든 메서드는 인자로 null이 전달되면 NullPointException을 발생시킨다.

 

· 점검 지정 예외 뿐만 아니라, 무점검 예외에도 문서를 만들어라.

 

· 일반 메서드 뿐만 아니라, abstract메서드에도 문서를 만들어라.

 

· 점검지정 예외는 메서드의 throws절에 나열하라.

 

· 무점검 지정 예외는 throws에 적지 마라.