[Chap 3] 우선정리부터 슬기롭게 주석 사용하기

• 지나치게 많은 주석 없애기
  1. 주석은 중요한 정보를 설명할 때 사용
  2. 너무 많은 주석은 코드사용하지 않기
  3. 프로젝트시 팀원들의 이해를 도울정도만!
• 주석 처리된 코드 제거
  1. 주석처리 코드는 이해도를 떨어트린다.
  2. 잃어버리고 싶지않은 코드라면 Git을 통해관리하자.
• 주석을 상수로 대체
  1. 주석은 코드를 설명하는데 필요하지만, 코드로 직접설명하는것이 효율적이다.
  2. 매직넘버의 설명 주석보다는 상수로 대체 사용하자.
• 주석을 유틸리티 메서드로 대체
  1. 주석을 상수로 사용 할 수 없을 경우 메서드로 정의하자.
  2. 메서드 이름을 통해 무엇을 return할 지 파악이 가능하다.
  3. 메서드가 늘어나지만, 코드가 짧아져 이해하기 쉽다.
  4. 메서드를 재사용 할 수 있다. 
• 구현 결정 설명하기
  1. 중요한 결정이나 코드에서 까다로운 부분을 설명할 때는 팀내의 규칙 템플릿을 사용
• 예제로 설명하기
  1. 복잡한 정규식과 같은 코드는 주석을 통한 설명을 반영하자.
  2. 코드가 길고 구조적이지만 정보가 더 많이 제공된다.
• 패키지를 JavaDoc으로 구조화하기
• 메서드를 JavaDoc으로 구조화하기
• 생성자를 JavaDoc으로 구조화하기