예외 문서화 - 메서드가 던지는 예외는 그 메서드를 올바르게 사용하기 위한 중요한 정보이므로 예외 하나하나를 문서화 하는데 충분한 시간을 쏟아야 한다. 검사 예외는 항상 따로따로 선언하고, 각 예외가 발생하는 상황을 자바독의 @throws 태그를 사용하여 정확히 문서화하자. 공통 상위 클래스 하나로 예외를 던지는 것을 삼가하자 ex> Exception, Throwable(main 메서드만 제외) 비검사 예외도 검사 예외처럼 정성껏 문서화 해두면 좋음 -> 그 메서드를 성공적으로 수행하기 위한 전제조건이 된다. 메서드가 던질 수 있는 예외를 @throws 로 문서화하되, 비검사 예외는 메서드 선언의 throws목록에 넣지 말자(검사냐 비검사냐 따라 API 사용자가 할 일이 달라지므로 확실히 구분하자.) /..

자바독(Javadoc) 소스코드 파일에서 문서화 주석이라는 특수한 형태로 기술된 설명을 추려 API문서로 변환한다. API를 올바르게 문서화하려면 공개된 모든 클래스, 인터페이스, 메서드 , 필드 선언에 문서화 주석을 달아야 한다. 문서가 잘 갖춰지지 않은 API는 쓰기 헷갈려서 오류의 원인이 되기 쉽다. 공개 클래스는 절대 기본 생성자를 사용하면 안 된다(기본 생성자에는 주석 X) 메서드용 문서화 주석에는 해당 메서드와 클라이언트 사이의 규약을 명료하게 기술해야 한다. How가 아닌 What을 기술할 것 클라이언트가 해당 메서드를 호출하기 위한 전제조건을 모두 나열할 것 성공적으로 수행된 후에 만족해야 하는 사후 조건도 모두 나열할 것 전제조건은 @throws 태그로 비검사 예외를 선언하여 암시적으로 ..