item 19 leekyunghee - JAVA-JIKIMI/EFFECTIVE-JAVA3 GitHub Wiki

상속을 고려해 설계하고 문서화하라. 그러지 않았다면 상속을 금지하라.

• 상속을 고려한 설계와 문서화
• 메서드를 재정의하면 어떤 일이 일어나는지를 정확히 정리하여 문서로 남겨야 한다.
• 상속용 클래스는 재정의할 수 있는 메서드들을 내부적으로 어떻게 이용하는지(자기사용) 문서로 남겨야한다.
• 클래스의 API로 공개된 메서드에서 클래스 자신의 또 다른 메서드를 호출할 수도 있다.
• 호출되는 메서드가 재정의 가능 메서드라면 그 사실을 호출하는 메서드의 API 설명에 적시해야 한다.

바쁠땐 이정도만이라도 작성
/**
 * 사이즈 설정
 *
 * @param width 폭
 * @param height 높이
 * @return 계산한 면적
 */

핵심 정리

API 설계 문서를 잘 작성하자. 
- 상속용으로 설계한 클래스는 배포 전에 반드시 하위 클래스를 만들어 검증해야 한다. 
- 다른 이가 효율 좋은 하위 클래스를 만들 수 있도록 일부 메서드를 protected로 제공해야 할 수도 있다. 
- 클래스를 확장해야 할 명확한 이유가 떠오르지 않으면 상속을 금지하는 편이 나을 것.