냄새 24. 주석

들어가기 전

이 글은 인프런 백기선님의 강의를 복습하며 작성한 글입니다.

---

냄새 24. 주석(Comments)

• 주석을 남겨야 할 것 같다면 먼저 코드를 리팩토링 하라. 불필요한 주석을 줄일 수 있다. 
  • 주석은 좋은 냄새에 해당한다.
  • 주석 중 일부는 안 좋은 코드 냄새를 나타내기도 하기 때문이다. 예를 들어 주석 자체가 '긴 메서드 냄새'를 암시하는 힌트가 될 수도 있다.
• 관련 리팩토링
  • '함수 추출하기'를 사용해 설명이 필요한 부분을 별도의 메서드로 빼낸다.
  • '함수 선언부 변경하기'를 사용해 함수 이름을 재정의 할 수 있다. (함수의 이름이 직관적이지 않은 경우)
  • 시스템적으로 어떤 필요한 규칙(Validation)이 있다면, 'Assertion 추가하기'를 적용할 수 있다. 
    • 주석으로 시스템적으로 가정하고 있는 규칙들이 있다면, 이것을 Assertion 문을 이용해서 명시적으로 나타낼 수 있다. 정말 런타임에서 확인해야 한다면, Assertion이 아니라 조건문으로 수정이 필요하다.