냄새 24. 주석 Comments

• 주석을 남겨야 할 것 같다면 먼저 코드를 리팩토링하라. 불필요한 주석을 줄일 수 있다.
  • 모든 주석이 나쁘다는 것도 아니고, 주석을 쓰지 말자는 것도 아니다.
  • 주석은 좋은 냄새에 해당하기도 한다.
• 관련 리팩토링
  • "함수 추출하기"를 사용해 설명이 필요한 부분을 별도의 메소드로 빼낸다.
  • "함수 선언부 변경하기"를 사용해 함수 이름을 재정의할 수 있다.
  • 시스템적으로 어떤 필요한 규칙이 있다면, "어서션 추가하기 (Introduce Assertion)"을 적용할 수 있다.

리팩토링 43. 어서션 추가하기 Introduce Assertion

• 종종 코드로 표현하지 않았지만 기본적으로 가정하고 있는 조건들이 있다. 그런 조건을 알 고리듬을 파악하거나 주석을 읽으면서 확인할 수 있다.
• 그러한 조건을 Assertion을 사용해서 보다 명시적으로 나타낼 수 있다.
• Assertion은 if나 swtich 문과 달리 "항상" true이길 기대하는 조건을 표현할 때 사용한다.
  • 프로그램이 Assertion에서 실패한다면 프로그래머의 실수로 생각할 수 있다.
  • Assertion이 없어도 프로그램이 동작해야 한다. (자바에서는 컴파일 옵션으로 assert 문 을 사용하지 않도록 설정할 수도 있다.)
• 특정 부분에선 특정한 상태를 가정하고 있다는 것을 명시적으로 나타냄로써, 의사소통적인 가치를 지니고 있다.